Merge pull request #114 from code42/chore/prep-agent-health-release

Prep agent health release

Author: tora-kozic

CHANGELOG.md

@@ -9,6 +9,26 @@
  how a consumer would use the library or CLI tool (e.g. adding unit tests, updating documentation, etc) are not captured
  here.
 
+## 1.2.0 - 2024-3-18
+
+### Added
+
+- The following agent health related fields will be present on the response when retrieving agents:
+  - `serialNumber`
+  - `machineId`
+  - `agentHealthIssueTypes`
+- Additional optional args in the SDK's agent client for filtering by agent health.
+  - `client.agents.v1.get_page()` and `client.agents.v1.get_page()` now accept:
+    - `agent_healthy: bool` - Retrieve only healthy agents with `True` or only unhealthy agents with `False`.  Defaults to returning all agents.
+    - `agent_health_issue_types: List[str] | str`- Retrieve agents with any of the given health issues. Ex: `NOT_CONNECTING`
+- Additional options in the CLI's agent command group for filtering by agent health:
+  - `incydr agents list` now accepts:
+    - `--healthy` - Retrieve only healthy agents.
+    - `--unhealthy` - Retrieve only unhealthy agents.
+    - Pass a comma separated list of health issue types to the unhealthy option to filter for agents with any of the given health issues. Ex: `--unhealthy NOT_CONNECTING,NOT_SENDING_SECURITY_EVENTS`
+    - Use `incydr agents list --help` to see more specifics on the new command options.
+- See the [SDK documentation](https://developer.code42.com/sdk/clients/agents/) and the [CLI documentation](https://developer.code42.com/cli/cmds/agents/#agents-list) for more details.
+
 ## 1.1.2 - 2023-12-11
 
 ### Fixed

CONTRIBUTING.md

@@ -1,5 +1,19 @@
 # Contributing
 
+To test changes on a branch that haven't been released yet, you'll have to pull down the branch and
+install the SDK/CLI in `editable` mode using `pip intall -e`. Navigate to the `incydr_python` directory and to install from your local path
+(rather than from a released version on PyPI) use:
+
+```bash
+pip install -e .
+```
+
+To install the CLI extension in a similar manner:
+
+ ```bash
+ pip install -e .'[cli]'
+ ```
+
 ## Install hatch
 
 The Incydr SDK uses [Hatch](https://hatch.pypa.io/latest/) as its Python project manager.

src/_incydr_sdk/__version__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2022-present Code42 Software <integrations@code42.com>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "1.1.2"
+__version__ = "1.2.0"

src/_incydr_sdk/agents/client.py

@@ -38,7 +38,7 @@ def get_page(
         page_num: int = 1,
         page_size: int = 500,
         agent_healthy: bool = None,
-        agent_health_issue_types: List[str] = None,
+        agent_health_issue_types: Union[List[str], str] = None,
     ) -> AgentsPage:
         """
         Get a page of agents.
@@ -62,7 +62,9 @@ def get_page(
             active=active,
             agentType=agent_type,
             agentHealthy=agent_healthy,
-            anyOfAgentHealthIssueTypes=agent_health_issue_types,
+            anyOfAgentHealthIssueTypes=[agent_health_issue_types]
+            if isinstance(agent_health_issue_types, str)
+            else agent_health_issue_types,
             srtDir=sort_dir,
             srtKey=sort_key,
             pageSize=page_size,