Measurement creation new fields (#255)

* Measurement new fields for auto-topup, target refresh and aggregator client id

* Ruff format

Author: iannuzzelli

ripe/atlas/tools/commands/measure/base.py

@@ -17,6 +17,7 @@
 import os
 import re
 import webbrowser
+import hashlib
 
 from collections import OrderedDict
 
@@ -43,7 +44,6 @@
 
 
 class Command(BaseCommand):
-
     NAME = "measure"
 
     DESCRIPTION = "Create a measurement and optionally wait for the results"
@@ -61,14 +61,12 @@ class Command(BaseCommand):
     )
 
     def __init__(self, *args, **kwargs):
-
         self._type = None
         self._is_oneoff = True
 
         BaseCommand.__init__(self, *args, **kwargs)
 
     def _modify_parser_args(self, args):
-
         kinds = self.CREATION_CLASSES.keys()
         error = (
             "Usage: ripe-atlas measure <{}> [options]\n"
@@ -90,7 +88,6 @@ def _modify_parser_args(self, args):
         return BaseCommand._modify_parser_args(self, args)
 
     def add_arguments(self):
-
         self.parser.add_argument(
             "--renderer",
             choices=Renderer.get_available(),
@@ -238,6 +235,43 @@ def add_arguments(self):
             help="Exclude probes that are marked with these tags. "
             "Example: --exclude-tag=system-ipv6-works",
         )
+        self.add_flag(
+            parser=self.parser,
+            name="auto-topup",
+            default=conf["specification"]["auto_topup"],
+            help="Automatic top-up measurements probes."
+            "Applicable to periodic measurements only.",
+        )
+        self.parser.add_argument(
+            "--auto-topup-prb-days-off",
+            type=ArgumentType.integer_range(1, 30),
+            default=conf["specification"]["auto_topup_prb_days_off"],
+            help="Threshold in days to replace a disconnected probe."
+            "Applicable to periodic measurements only."
+            "Example: --auto-topup-prb-days-off=7",
+        )
+        self.parser.add_argument(
+            "--auto-topup-prb-similarity",
+            type=ArgumentType.float_range(minimum=0, maximum=1),
+            default=conf["specification"]["auto_topup_prb_similarity"],
+            help="Minimum similarity for replacement probes"
+            "Applicable to periodic measurements only."
+            "Example: --auto-topup-prb-similarity=0.5",
+        )
+        self.parser.add_argument(
+            "--target-update-hours",
+            type=ArgumentType.integer_range(22, 720),
+            default=conf["specification"]["target_update_hours"],
+            help="Number of hours to re-lookup a target DNS record."
+            "Example: --target-update-hours=24",
+        )
+        self.parser.add_argument(
+            "--aggregator-client-id",
+            type=str,
+            default=conf["specification"]["aggregator_client_id"],
+            help="Client ID for measurement aggregators."
+            "The value is hashed on transmission.",
+        )
 
         self.parser.add_argument(
             "--group-id",
@@ -280,7 +314,6 @@ def add_arguments(self):
         Renderer.add_arguments_for_available_renderers(self.parser)
 
     def run(self) -> None:
-
         self._account_for_selected_probes()
 
         if self.arguments.dry_run:
@@ -315,7 +348,6 @@ def run(self) -> None:
             self.stream(msm_id)
 
     def dry_run(self):
-
         print(colourise("\nDefinitions:\n{}".format("=" * 80), "bold"))
 
         for param, val in self._get_measurement_kwargs().items():
@@ -371,7 +403,6 @@ def stream(self, msm_id: int) -> None:
         self.ok("Disconnected from stream")
 
     def clean_target(self):
-
         if not self.arguments.target:
             raise RipeAtlasToolsException(
                 "You must specify a target for that kind of measurement"
@@ -389,7 +420,6 @@ def clean_description(self):
         )
 
     def _get_measurement_kwargs(self):
-
         # This is kept apart from the r = {} because dns measurements don't
         # require a target attribute
         target = self.clean_target()
@@ -404,6 +434,16 @@ def _get_measurement_kwargs(self):
             r["interval"] = self.arguments.interval
             self._is_oneoff = False
             self.arguments.no_report = True
+            # auto-topup is applicable only to periodic measurements
+            if self.arguments.auto_topup is not None:
+                r["auto_topup"] = self.arguments.auto_topup
+            if self.arguments.auto_topup_prb_days_off is not None:
+                r["auto_topup_prb_days_off"] = self.arguments.auto_topup_prb_days_off
+            if self.arguments.auto_topup_prb_similarity is not None:
+                r["auto_topup_prb_similarity"] = (
+                    self.arguments.auto_topup_prb_similarity
+                )
+
         elif not spec["times"]["one-off"]:
             raise RipeAtlasToolsException(
                 "Your configuration file appears to be setup to not create "
@@ -427,10 +467,17 @@ def _get_measurement_kwargs(self):
         if self.arguments.resolve_on_probe is not None:
             r["resolve_on_probe"] = self.arguments.resolve_on_probe
 
+        if self.arguments.target_update_hours:
+            r["target_update_hours"] = self.arguments.target_update_hours
+
+        if self.arguments.aggregator_client_id:
+            r["aggregator_client_id"] = hashlib.sha256(
+                self.arguments.aggregator_client_id.encode("utf-8")
+            ).hexdigest()
+
         return r
 
     def _get_source_kwargs(self):
-
         r = conf["specification"]["source"]
 
         r["requested"] = self.arguments.probes
@@ -505,7 +552,6 @@ def _account_for_selected_probes(self):
 
     @staticmethod
     def _handle_api_error(response):
-
         message = "There was a problem communicating with the RIPE Atlas API."
 
         if isinstance(response, dict):
@@ -517,7 +563,6 @@ def _handle_api_error(response):
                     "using:\n\n"
                     " ripe-atlas configure --set authorisation.create=MY_API_KEY\n"
                 )
-
         message += f"\n\n{json.dumps(response, indent=2)}"
 
         raise RipeAtlasToolsException(message)

ripe/atlas/tools/commands/measurement_info.py

@@ -82,6 +82,10 @@ def render_basic(cls, measurement):
                 ("is_all_scheduled", "Fully Scheduled?", cls._prettify_boolean),
                 ("resolved_ips", "Resolved IPs", lambda _: ", ".join(_)),
                 ("resolve_on_probe", "Resolve on the Probe", cls._prettify_boolean),
+                ("auto_topup", "Auto-topup probes", cls._prettify_boolean),
+                ("auto_topup_prb_days_off", "Auto-topup min disconnected days"),
+                ("auto_topup_prb_similarity", "Auto-topup probe similarity"),
+                ("target_update_hours", "Target update hours"),
             ),
         )
 

ripe/atlas/tools/helpers/validators.py

@@ -123,6 +123,28 @@ def __call__(self, string):
 
             return integer
 
+    class float_range(object):
+        def __init__(self, minimum=float("-inf"), maximum=float("inf")):
+            self.minimum = minimum
+            self.maximum = maximum
+
+        def __call__(self, string):
+
+            message = "The number must be between {} and {}.".format(
+                self.minimum, self.maximum
+            )
+            if self.maximum == float("inf"):
+                message = "The number must be greater than {}.".format(self.minimum)
+
+            try:
+                number = float(string)
+                if number < self.minimum or number > self.maximum:
+                    raise argparse.ArgumentTypeError(message)
+            except ValueError:
+                raise argparse.ArgumentTypeError("A number must be specified.")
+
+            return number
+
     class comma_separated_integers(object):
         def __init__(self, minimum=float("-inf"), maximum=float("inf")):
             self.minimum = minimum

ripe/atlas/tools/settings/__init__.py

@@ -81,6 +81,11 @@ class Configuration(UserSettingsParser):
             },
             "spread": None,
             "resolve_on_probe": None,
+            "auto_topup": None,
+            "auto_topup_prb_days_off": None,
+            "auto_topup_prb_similarity": None,
+            "target_update_hours": None,
+            "aggregator_client_id": None,
             "times": {
                 "one-off": True,
                 "interval": None,