process_tracker_python-150 Change process_run_id to process_tracking_id

✨ Changed variable name to match data model

Changed process_run_id to process_tracking_id to avoid confusion.

Closes #150

Author: Alex Meadows

process_tracker/process_tracker.py

@@ -73,7 +73,7 @@ def __init__(
         config_location=None,
         dataset_types=None,
         schedule_frequency=None,
-        process_run_id=None,
+        process_tracking_id=None,
     ):
         """
         ProcessTracker is the primary engine for tracking data integration processes.
@@ -104,9 +104,9 @@ def __init__(
         :type dataset_types: list
         :param schedule_frequency: The general scheduling frequency for the process (i.e. hourly)
         :type schedule_frequency: string
-        :param process_run_id: If trying to access an already running process, provide the process run's id.
+        :param process_tracking_id: If trying to access an already running process, provide the process run's id.
         Object will be built for that specific process run.
-        :type process_run_id: int
+        :type process_tracking_id: int
         """
         self.config_location = config_location
         self.config = SettingsManager(config_location=self.config_location)
@@ -128,11 +128,13 @@ def __init__(
         self.process_status_failed = self.process_status_types["failed"]
         self.process_status_hold = self.process_status_types["on hold"]
 
-        if process_run_id is not None:
+        if process_tracking_id is not None:
             self.logger.info("Process run id provided.  Checking if exists.")
 
             process_run = self.data_store.get_or_create_item(
-                model=ProcessTracking, process_tracking_id=process_run_id, create=False
+                model=ProcessTracking,
+                process_tracking_id=process_tracking_id,
+                create=False,
             )
 
             if process_run is not None:
@@ -145,18 +147,20 @@ def __init__(
 
                 self.dataset_types = process_run.process.dataset_types
                 self.sources = self.determine_process_sources(
-                    process_run_id=process_run_id
+                    process_run_id=process_tracking_id
                 )
                 self.targets = self.determine_process_targets(
-                    process_run_id=process_run_id
+                    process_run_id=process_tracking_id
                 )
 
                 self.process_name = process_run.process.process_name
                 self.process_tracking_run = process_run
                 self.process_run_name = process_run.process_run_name
 
             else:
-                error_msg = "Process run not found based on id %s." % process_run_id
+                error_msg = (
+                    "Process run not found based on id %s." % process_tracking_id
+                )
                 self.logger.error(error_msg)
                 raise Exception(error_msg)
         else:
@@ -325,7 +329,7 @@ def determine_hold_status(self, last_run_status, last_run_id):
         Based on the setting 'max_concurrent_failures', count the number of failures for that number of process runs.
         If the counts match, process will remain on hold.  If last run is 'on_hold' process will remain on hold.
         :param last_run_status: The status of the previous run
-        :param last_run_id:  The process_run_id of the previous run
+        :param last_run_id:  The process_tracking_id of the previous run
         :return:
         """
         self.logger.debug("Determining if process should be put on or remain on hold.")
@@ -362,7 +366,7 @@ def determine_hold_status(self, last_run_status, last_run_id):
 
     def determine_process_sources(self, process_run_id):
         """
-        Based on the process_run_id, find the given process' sources - either at the attribute, object, or source level
+        Based on the process_tracking_id, find the given process' sources - either at the attribute, object, or source level
         :param process_run_id: Process run identifier
         :type process_run_id: int
         :return: Array of source objects at lowest granularity.
@@ -425,7 +429,7 @@ def determine_process_sources(self, process_run_id):
 
     def determine_process_targets(self, process_run_id):
         """
-        Based on the process_run_id, find the given process' targets - either at the attribute, object, or source level
+        Based on the process_tracking_id, find the given process' targets - either at the attribute, object, or source level
         :param process_run_id: Process run identifier
         :type process_run_id: int
         :return: Array of source objects used as target for the process at lowest granularity.

tests/test_process_tracker.py

@@ -2150,7 +2150,7 @@ def test_process_tracker_with_process_run_id(self):
         """
         process_run_id = self.process_tracker.process_tracking_run.process_tracking_id
 
-        new_process_tracker = ProcessTracker(process_run_id=process_run_id)
+        new_process_tracker = ProcessTracker(process_tracking_id=process_run_id)
 
         expected_process_name_result = self.process_tracker.process_name
         given_process_name_result = new_process_tracker.process_name
@@ -2193,7 +2193,7 @@ def test_determine_process_sources(self):
         """
         process_run_id = self.process_tracker.process_tracking_run.process_tracking_id
 
-        new_process_tracker = ProcessTracker(process_run_id=process_run_id)
+        new_process_tracker = ProcessTracker(process_tracking_id=process_run_id)
 
         given_sources = new_process_tracker.sources
         expected_sources = self.process_tracker.sources
@@ -2208,7 +2208,7 @@ def test_determine_process_targets(self):
         """
         process_run_id = self.process_tracker.process_tracking_run.process_tracking_id
 
-        new_process_tracker = ProcessTracker(process_run_id=process_run_id)
+        new_process_tracker = ProcessTracker(process_tracking_id=process_run_id)
 
         given_targets = new_process_tracker.targets
         expected_targets = self.process_tracker.targets