machine_access_control 0.3.0__tar.gz → 0.4.0__tar.gz

{machine_access_control-0.3.0 → machine_access_control-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: machine_access_control
-Version: 0.3.0
+Version: 0.4.0
 Summary: Decatur Makers Machine Access Control package
 License: MIT
 License-File: LICENSE

{machine_access_control-0.3.0 → machine_access_control-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "machine_access_control"
-version = "0.3.0"
+version = "0.4.0"
 description = "Decatur Makers Machine Access Control package"
 authors = ["Jason Antman <jason@jasonantman.com>"]
 license = "MIT"

{machine_access_control-0.3.0 → machine_access_control-0.4.0}/src/dm_mac/models/machine.py

@@ -60,6 +60,11 @@ CONFIG_SCHEMA: Dict[str, Any] = {
                     "Displays 'Always On' and relay is always "
                     "on unless Oopsed or Locked.",
                 },
+                "alias": {
+                    "type": "string",
+                    "description": "Optional human-friendly alias for the machine. "
+                    "Used in Slack messages and logs instead of the machine name.",
+                },
             },
             "additionalProperties": False,
             "description": "Unique machine name, alphanumeric _ and - only.",
@@ -77,6 +82,7 @@ class Machine:
         authorizations_or: List[str],
         unauthorized_warn_only: bool = False,
         always_enabled: bool = False,
+        alias: Optional[str] = None,
     ):
         """Initialize a new MachineState instance."""
         #: The name of the machine
@@ -88,6 +94,8 @@ class Machine:
         self.unauthorized_warn_only: bool = unauthorized_warn_only
         #: Whether machine is always enabled without RFID authentication
         self.always_enabled: bool = always_enabled
+        #: Optional human-friendly alias for the machine
+        self.alias: Optional[str] = alias
         #: state of the machine
         self.state: "MachineState" = MachineState(self)
 
@@ -145,6 +153,11 @@ class Machine:
             return
         await slack.log_unoops(self, source)
 
+    @property
+    def display_name(self) -> str:
+        """Return the display name for this machine (alias if present, else name)."""
+        return self.alias if self.alias else self.name
+
     @property
     def as_dict(self) -> Dict[str, Any]:
         """Return a dict representation of this machine."""
@@ -153,6 +166,7 @@ class Machine:
             "authorizations_or": self.authorizations_or,
             "unauthorized_warn_only": self.unauthorized_warn_only,
             "always_enabled": self.always_enabled,
+            "alias": self.alias,
         }
 
 
@@ -163,6 +177,7 @@ class MachinesConfig:
         """Initialize MachinesConfig."""
         logger.debug("Initializing MachinesConfig")
         self.machines_by_name: Dict[str, Machine] = {}
+        self.machines_by_alias: Dict[str, Machine] = {}
         self.machines: List[Machine] = []
         mdict: Dict[str, Any]
         mname: str
@@ -170,8 +185,16 @@ class MachinesConfig:
             mach: Machine = Machine(name=mname, **mdict)
             self.machines.append(mach)
             self.machines_by_name[mach.name] = mach
+            if mach.alias:
+                self.machines_by_alias[mach.alias] = mach
         self.load_time: float = time()
 
+    def get_machine(self, name_or_alias: str) -> Optional[Machine]:
+        """Get a machine by name or alias."""
+        return self.machines_by_name.get(name_or_alias) or self.machines_by_alias.get(
+            name_or_alias
+        )
+
     def _load_and_validate_config(self) -> Dict[str, Dict[str, Any]]:
         """Load and validate the config file."""
         config: Dict[str, Dict[str, Any]] = cast(
@@ -307,7 +330,8 @@ class MachineState:
         For always-enabled machines, restores the always-on state.
         """
         logging.getLogger("AUTH").warning(
-            "Machine %s rebooted; resetting relay and RFID state", self.machine.name
+            "Machine %s rebooted; resetting relay and RFID state",
+            self.machine.display_name,
         )
         # locking handled in update()
         self.current_user = None
@@ -327,12 +351,12 @@ class MachineState:
         if not slack:
             # Slack integration is not enabled
             return
-        await slack.admin_log(f"Machine {self.machine.name} has rebooted.")
+        await slack.admin_log(f"Machine {self.machine.display_name} has rebooted.")
 
     def lockout(self) -> None:
         """Lock-out the machine."""
         logging.getLogger("OOPS").warning(
-            "Machine %s was locked out for maintenance.", self.machine.name
+            "Machine %s was locked out for maintenance.", self.machine.display_name
         )
         with self._lock:
             self.is_locked_out = True
@@ -345,7 +369,8 @@ class MachineState:
     def unlock(self) -> None:
         """Un-lock-out the machine."""
         logging.getLogger("OOPS").warning(
-            "Machine %s was removed from maintenance lock-out.", self.machine.name
+            "Machine %s was removed from maintenance lock-out.",
+            self.machine.display_name,
         )
         with self._lock:
             self.is_locked_out = False
@@ -364,7 +389,9 @@ class MachineState:
 
     def oops(self, do_locking: bool = True) -> None:
         """Oops the machine."""
-        logging.getLogger("OOPS").warning("Machine %s was Oopsed.", self.machine.name)
+        logging.getLogger("OOPS").warning(
+            "Machine %s was Oopsed.", self.machine.display_name
+        )
         locker = self._lock if do_locking else nullcontext()
         with locker:
             self.is_oopsed = True
@@ -377,7 +404,7 @@ class MachineState:
     def unoops(self, do_locking: bool = True) -> None:
         """Un-oops the machine."""
         logging.getLogger("OOPS").warning(
-            "Machine %s was un-Oopsed.", self.machine.name
+            "Machine %s was un-Oopsed.", self.machine.display_name
         )
         locker = self._lock if do_locking else nullcontext()
         with locker:
@@ -465,7 +492,7 @@ class MachineState:
                 ustr = f" Current user is: {user.full_name}."
                 uname = user.full_name
         logging.getLogger("OOPS").warning(
-            "Machine %s was Oopsed.%s", self.machine.name, ustr
+            "Machine %s was Oopsed.%s", self.machine.display_name, ustr
         )
         # locking handled in update()
         self.oops(do_locking=False)
@@ -485,12 +512,12 @@ class MachineState:
         """Handle RFID card removed."""
         logging.getLogger("AUTH").info(
             "RFID logout on %s by %s; session duration %d seconds",
-            self.machine.name,
+            self.machine.display_name,
             self.current_user.full_name if self.current_user else self.rfid_value,
             time() - cast(float, self.rfid_present_since),
         )
         log_str: str = (
-            f"RFID logout on {self.machine.name} by "
+            f"RFID logout on {self.machine.display_name} by "
             + (self.current_user.full_name if self.current_user else "unknown")
             + "; session duration "
             + naturaldelta(time() - cast(float, self.rfid_present_since))
@@ -521,13 +548,13 @@ class MachineState:
         if not user:
             logging.getLogger("AUTH").warning(
                 "RFID login attempt on %s by unknown fob %s",
-                self.machine.name,
+                self.machine.display_name,
                 rfid_value,
             )
             if self.is_oopsed or self.is_locked_out:
                 if slack:
                     await slack.admin_log(
-                        f"RFID login attempt on {self.machine.name} "
+                        f"RFID login attempt on {self.machine.display_name} "
                         "by unknown fob when oopsed or locked out."
                     )
                 return
@@ -536,7 +563,7 @@ class MachineState:
             self.status_led_brightness = self.STATUS_LED_BRIGHTNESS
             if slack:
                 await slack.admin_log(
-                    f"RFID login attempt on {self.machine.name} by unknown fob"
+                    f"RFID login attempt on {self.machine.display_name} by unknown fob"
                 )
             return
         # ok, we have a known user
@@ -544,26 +571,26 @@ class MachineState:
         if self.is_oopsed:
             logging.getLogger("AUTH").warning(
                 "RFID login attempt while oopsed on %s by %s",
-                self.machine.name,
+                self.machine.display_name,
                 logname,
             )
             # don't change anything
             if slack:
                 await slack.admin_log(
-                    f"RFID login attempt on {self.machine.name} by "
+                    f"RFID login attempt on {self.machine.display_name} by "
                     f"{user.full_name} when oopsed."
                 )
             return
         if self.is_locked_out:
             logging.getLogger("AUTH").warning(
                 "RFID login attempt while locked out on %s by %s",
-                self.machine.name,
+                self.machine.display_name,
                 logname,
             )
             # don't change anything
             if slack:
                 await slack.admin_log(
-                    f"RFID login attempt on {self.machine.name} by "
+                    f"RFID login attempt on {self.machine.display_name} by "
                     f"{user.full_name} when machine locked-out."
                 )
             return
@@ -572,7 +599,7 @@ class MachineState:
                 "User %s (%s) authorized for %s; session start",
                 user.full_name,
                 user.account_id,
-                self.machine.name,
+                self.machine.display_name,
             )
             self.current_user = user
             self.relay_desired_state = True
@@ -581,7 +608,7 @@ class MachineState:
             self.status_led_brightness = self.STATUS_LED_BRIGHTNESS
             if slack:
                 await slack.admin_log(
-                    f"RFID login on {self.machine.name} by authorized user "
+                    f"RFID login on {self.machine.display_name} by authorized user "
                     f"{user.full_name}"
                 )
         else:
@@ -589,7 +616,7 @@ class MachineState:
                 "User %s (%s) UNAUTHORIZED for %s",
                 user.full_name,
                 user.account_id,
-                self.machine.name,
+                self.machine.display_name,
             )
             self.relay_desired_state = False
             self.display_text = "Unauthorized"
@@ -597,7 +624,7 @@ class MachineState:
             self.status_led_brightness = self.STATUS_LED_BRIGHTNESS
             if slack:
                 await slack.admin_log(
-                    f"rejected RFID login on {self.machine.name} by "
+                    f"rejected RFID login on {self.machine.display_name} by "
                     f"UNAUTHORIZED user {user.full_name}"
                 )
 
@@ -614,7 +641,7 @@ class MachineState:
             # RFID removed
             logging.getLogger("AUTH").info(
                 "RFID removed on always-enabled machine %s (was %s); session duration %d seconds",
-                self.machine.name,
+                self.machine.display_name,
                 self.current_user.full_name if self.current_user else self.rfid_value,
                 (
                     time() - cast(float, self.rfid_present_since)
@@ -635,14 +662,14 @@ class MachineState:
                 self.current_user = user
                 logging.getLogger("AUTH").info(
                     "RFID inserted on always-enabled machine %s by %s (%s)",
-                    self.machine.name,
+                    self.machine.display_name,
                     user.full_name,
                     rfid_value,
                 )
             else:
                 logging.getLogger("AUTH").warning(
                     "RFID inserted on always-enabled machine %s by unknown fob %s",
-                    self.machine.name,
+                    self.machine.display_name,
                     rfid_value,
                 )
             # State remains always-on (relay/display/LED not changed)
@@ -657,7 +684,7 @@ class MachineState:
                     "User %s (%s) authorized for %s based on %s",
                     user.full_name,
                     user.account_id,
-                    self.machine.name,
+                    self.machine.display_name,
                     auth,
                 )
                 return True
@@ -667,12 +694,12 @@ class MachineState:
                 "unauthorized_warn_only==True",
                 user.full_name,
                 user.account_id,
-                self.machine.name,
+                self.machine.display_name,
             )
             if slack:
                 await slack.admin_log(
                     f"WARNING - Authorizing user {user.full_name} for "
-                    f"{self.machine.name} based on unauthorized_warn_only "
+                    f"{self.machine.display_name} based on unauthorized_warn_only "
                     "setting for machine. User is NOT authorized for this "
                     "machine."
                 )

{machine_access_control-0.3.0 → machine_access_control-0.4.0}/src/dm_mac/slack_handler.py

@@ -160,11 +160,11 @@ class SlackHandler:
                 msg.channel_id,
             )
             return None
-        if msg.command[0] == "oops" and len(msg.command) == 2:
+        if msg.command[0] == "oops" and len(msg.command) >= 2:
             return await self.oops(msg, say)
-        elif msg.command[0] == "lock" and len(msg.command) == 2:
+        elif msg.command[0] == "lock" and len(msg.command) >= 2:
             return await self.lock(msg, say)
-        elif msg.command[0] == "clear" and len(msg.command) == 2:
+        elif msg.command[0] == "clear" and len(msg.command) >= 2:
             return await self.clear(msg, say)
         await say(self.HELP_RESPONSE)
 
@@ -175,7 +175,7 @@ class SlackHandler:
         mname: str
         mach: Machine
         for mname, mach in sorted(mconf.machines_by_name.items()):
-            resp += mname + ": "
+            resp += mach.display_name + ": "
             if mach.state.is_oopsed or mach.state.is_locked_out:
                 if mach.state.is_oopsed:
                     resp += "Oopsed "
@@ -199,44 +199,44 @@ class SlackHandler:
 
     async def oops(self, msg: Message, say: AsyncSay) -> None:
         """Set oops status on a machine."""
-        mname: str = msg.command[1]
+        mname: str = " ".join(msg.command[1:])
         mconf: MachinesConfig = self.quart.config["MACHINES"]
-        mach: Optional[Machine] = mconf.machines_by_name.get(mname)
+        mach: Optional[Machine] = mconf.get_machine(mname)
         if not mach:
             await say(
-                f"Invalid machine name '{mname}'. Use status command to "
+                f"Invalid machine name or alias '{mname}'. Use status command to "
                 f"list all machines."
             )
             return
         if mach.state.is_oopsed:
-            await say(f"Machine {mname} is already oopsed.")
+            await say(f"Machine {mach.display_name} is already oopsed.")
             return
         await mach.oops(slack=self)
 
     async def lock(self, msg: Message, say: AsyncSay) -> None:
         """Set lock status on a machine."""
-        mname: str = msg.command[1]
+        mname: str = " ".join(msg.command[1:])
         mconf: MachinesConfig = self.quart.config["MACHINES"]
-        mach: Optional[Machine] = mconf.machines_by_name.get(mname)
+        mach: Optional[Machine] = mconf.get_machine(mname)
         if not mach:
             await say(
-                f"Invalid machine name '{mname}'. Use status command to "
+                f"Invalid machine name or alias '{mname}'. Use status command to "
                 f"list all machines."
             )
             return
         if mach.state.is_locked_out:
-            await say(f"Machine {mname} is already locked-out.")
+            await say(f"Machine {mach.display_name} is already locked-out.")
             return
         await mach.lockout(slack=self)
 
     async def clear(self, msg: Message, say: AsyncSay) -> None:
         """Clear oops and lock status on a machine."""
-        mname: str = msg.command[1]
+        mname: str = " ".join(msg.command[1:])
         mconf: MachinesConfig = self.quart.config["MACHINES"]
-        mach: Optional[Machine] = mconf.machines_by_name.get(mname)
+        mach: Optional[Machine] = mconf.get_machine(mname)
         if not mach:
             await say(
-                f"Invalid machine name '{mname}'. Use status command to "
+                f"Invalid machine name or alias '{mname}'. Use status command to "
                 f"list all machines."
             )
             return
@@ -248,7 +248,7 @@ class SlackHandler:
             await mach.unlock(slack=self)
             acted = True
         if not acted:
-            await say(f"Machine {mname} is not oopsed or locked-out.")
+            await say(f"Machine {mach.display_name} is not oopsed or locked-out.")
 
     async def log_unoops(self, machine: Machine, source: str) -> None:
         """
@@ -262,13 +262,13 @@ class SlackHandler:
         create_task(
             self.app.client.chat_postMessage(
                 channel=self.control_channel_id,
-                text=f"Machine {machine.name} un-oopsed via {source}.",
+                text=f"Machine {machine.display_name} un-oopsed via {source}.",
             )
         )
         create_task(
             self.app.client.chat_postMessage(
                 channel=self.oops_channel_id,
-                text=f"Machine {machine.name} oops has been cleared.",
+                text=f"Machine {machine.display_name} oops has been cleared.",
             )
         )
 
@@ -286,13 +286,13 @@ class SlackHandler:
         create_task(
             self.app.client.chat_postMessage(
                 channel=self.control_channel_id,
-                text=f"Machine {machine.name} oopsed via {source} by {user_name}.",
+                text=f"Machine {machine.display_name} oopsed via {source} by {user_name}.",
             )
         )
         create_task(
             self.app.client.chat_postMessage(
                 channel=self.oops_channel_id,
-                text=f"Machine {machine.name} has been Oops'ed!",
+                text=f"Machine {machine.display_name} has been Oops'ed!",
             )
         )
 
@@ -308,13 +308,13 @@ class SlackHandler:
         create_task(
             self.app.client.chat_postMessage(
                 channel=self.control_channel_id,
-                text=f"Machine {machine.name} locked-out cleared via {source}.",
+                text=f"Machine {machine.display_name} locked-out cleared via {source}.",
             )
         )
         create_task(
             self.app.client.chat_postMessage(
                 channel=self.oops_channel_id,
-                text=f"Machine {machine.name} is no longer locked-out for "
+                text=f"Machine {machine.display_name} is no longer locked-out for "
                 f"maintenance.",
             )
         )
@@ -331,13 +331,13 @@ class SlackHandler:
         create_task(
             self.app.client.chat_postMessage(
                 channel=self.control_channel_id,
-                text=f"Machine {machine.name} locked-out via {source}.",
+                text=f"Machine {machine.display_name} locked-out via {source}.",
             )
         )
         create_task(
             self.app.client.chat_postMessage(
                 channel=self.oops_channel_id,
-                text=f"Machine {machine.name} is locked-out for maintenance.",
+                text=f"Machine {machine.display_name} is locked-out for maintenance.",
             )
         )
 

{machine_access_control-0.3.0 → machine_access_control-0.4.0}/src/dm_mac/views/prometheus.py

@@ -134,52 +134,35 @@ class PromCustomCollector:
         )
         m: Machine
         for m in mconf.machines:
-            relay_state.add_metric(
-                {"machine_name": m.name}, 1 if m.state.relay_desired_state else 0
-            )
-            oops_state.add_metric(
-                {"machine_name": m.name}, 1 if m.state.is_oopsed else 0
-            )
-            lockout_state.add_metric(
-                {"machine_name": m.name}, 1 if m.state.is_locked_out else 0
-            )
-            unauth_state.add_metric(
-                {"machine_name": m.name}, 1 if m.unauthorized_warn_only else 0
-            )
-            m_checkin.add_metric({"machine_name": m.name}, m.state.last_checkin or 0)
-            m_update.add_metric({"machine_name": m.name}, m.state.last_update or 0)
-            m_rfid_present.add_metric(
-                {"machine_name": m.name}, 1 if m.state.rfid_value else 0
-            )
-            m_rfid_present_since.add_metric(
-                {"machine_name": m.name}, m.state.rfid_present_since or 0
-            )
-            current_amps.add_metric({"machine_name": m.name}, m.state.current_amps)
-            m_user.add_metric(
-                {"machine_name": m.name}, 1 if m.state.current_user else 0
-            )
-            uptime.add_metric({"machine_name": m.name}, m.state.uptime)
-            wifi_db.add_metric({"machine_name": m.name}, m.state.wifi_signal_db or 0)
-            wifi_percent.add_metric(
-                {"machine_name": m.name}, m.state.wifi_signal_percent or 0
-            )
-            temp_c.add_metric(
-                {"machine_name": m.name}, m.state.internal_temperature_c or 0
-            )
+            labels = {"machine_name": m.name, "display_name": m.display_name}
+            relay_state.add_metric(labels, 1 if m.state.relay_desired_state else 0)
+            oops_state.add_metric(labels, 1 if m.state.is_oopsed else 0)
+            lockout_state.add_metric(labels, 1 if m.state.is_locked_out else 0)
+            unauth_state.add_metric(labels, 1 if m.unauthorized_warn_only else 0)
+            m_checkin.add_metric(labels, m.state.last_checkin or 0)
+            m_update.add_metric(labels, m.state.last_update or 0)
+            m_rfid_present.add_metric(labels, 1 if m.state.rfid_value else 0)
+            m_rfid_present_since.add_metric(labels, m.state.rfid_present_since or 0)
+            current_amps.add_metric(labels, m.state.current_amps)
+            m_user.add_metric(labels, 1 if m.state.current_user else 0)
+            uptime.add_metric(labels, m.state.uptime)
+            wifi_db.add_metric(labels, m.state.wifi_signal_db or 0)
+            wifi_percent.add_metric(labels, m.state.wifi_signal_percent or 0)
+            temp_c.add_metric(labels, m.state.internal_temperature_c or 0)
             led.add_metric(
-                {"machine_name": m.name, "led_attribute": "red"},
+                {**labels, "led_attribute": "red"},
                 m.state.status_led_rgb[0],
             )
             led.add_metric(
-                {"machine_name": m.name, "led_attribute": "green"},
+                {**labels, "led_attribute": "green"},
                 m.state.status_led_rgb[1],
             )
             led.add_metric(
-                {"machine_name": m.name, "led_attribute": "blue"},
+                {**labels, "led_attribute": "blue"},
                 m.state.status_led_rgb[2],
             )
             led.add_metric(
-                {"machine_name": m.name, "led_attribute": "brightness"},
+                {**labels, "led_attribute": "brightness"},
                 m.state.status_led_brightness,
             )
         yield mconf_load