devopsdriver 0.1.44__tar.gz → 0.1.45__tar.gz

{devopsdriver-0.1.44 → devopsdriver-0.1.45}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: devopsdriver
-Version: 0.1.44
+Version: 0.1.45
 Summary: DevOps tools
 Author-email: Marc Page <marcallenpage@gmail.com>
 License: This is free and unencumbered software released into the public domain.
@@ -40,7 +40,7 @@ Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: The Unlicense (Unlicense)
-Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.10
 Classifier: Topic :: Utilities
 Classifier: Topic :: Software Development
 Requires-Python: >=3.10
@@ -48,9 +48,9 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML==6.0.1
 Requires-Dist: keyring==25.1.0
-Requires-Dist: setuptools==69.2.0
+Requires-Dist: setuptools==69.5.1
 Requires-Dist: azure-devops==7.1.0b4
-Requires-Dist: Mako==1.3.2
+Requires-Dist: Mako==1.3.3
 Provides-Extra: dev
 Requires-Dist: black>=24.3.0; extra == "dev"
 Requires-Dist: pylint>=3.1.0; extra == "dev"
@@ -60,7 +60,7 @@ Requires-Dist: coverage>=7.4.4; extra == "test"
 Provides-Extra: doc
 
 ![status sheild](https://img.shields.io/static/v1?label=status&message=beta&color=blue&style=plastic)
-[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.44&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.44/)
+[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.45&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.45/)
 [![GitHub](https://img.shields.io/github/license/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver?tab=Unlicense-1-ov-file#readme)
 [![GitHub contributors](https://img.shields.io/github/contributors/marcpage/devops-driver?style=flat)](https://github.com/marcpage/devops-driver/graphs/contributors)
 [![PR's Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)

{devopsdriver-0.1.44 → devopsdriver-0.1.45}/README.md

@@ -1,5 +1,5 @@
 ![status sheild](https://img.shields.io/static/v1?label=status&message=beta&color=blue&style=plastic)
-[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.44&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.44/)
+[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.45&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.45/)
 [![GitHub](https://img.shields.io/github/license/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver?tab=Unlicense-1-ov-file#readme)
 [![GitHub contributors](https://img.shields.io/github/contributors/marcpage/devops-driver?style=flat)](https://github.com/marcpage/devops-driver/graphs/contributors)
 [![PR's Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)

{devopsdriver-0.1.44 → devopsdriver-0.1.45}/devopsdriver/__init__.py

@@ -6,6 +6,6 @@ from .template import Template
 from .azdo.clients import Azure
 
 
-__version__ = "0.1.44"
+__version__ = "0.1.45"
 __author__ = "Marc Page"
 __credits__ = ""

devopsdriver-0.1.45/devopsdriver/azdo/builds/build.py

@@ -0,0 +1,74 @@
+#!/usr/bin/env python3
+
+""" Azure Build """
+
+from azure.devops.v7_1.build.models import Build as AzureBuild
+from azure.devops.v7_1.build import BuildClient
+from azure.devops.v7_1.build.models import TimelineRecord
+
+from devopsdriver.azdo import AzureObject
+
+
+class Build(AzureObject):  # pylint: disable=too-few-public-methods
+    """Azure Build"""
+
+    def __init__(self, client: BuildClient, build: AzureBuild):
+        self.client = client
+        self.build = build
+        super().__init__(build)
+
+    class Step(AzureObject):  # pylint: disable=too-few-public-methods
+        """Azure Build Step (job, task, step)"""
+
+        def __init__(self, entry: TimelineRecord):
+            self.children = []
+            self.log_contents: str = None
+            super().__init__(entry)
+
+        def all_logs(self) -> list[str]:
+            """Get a list of all logs in chronological order
+
+            Returns:
+                list[str]: List of all the logs
+            """
+            logs = [] if self.log_contents is None else [self.log_contents]
+
+            for child in self.children:
+                logs.extend(child.all_logs())
+
+            return logs
+
+    def __add_steps_and_logs(self, entry: Step, to_process: list[Step]) -> Step:
+        project = self.build.project.name
+        build_id = self.build.id
+
+        if entry.log:
+            entry.log_contents = "\n".join(
+                self.client.get_build_log_lines(project, build_id, entry.log.id)
+            )
+
+        entry.children = [e for e in to_process if e.parent_id == entry.id]
+
+        for child in entry.children:
+            to_process.remove(child)
+            self.__add_steps_and_logs(child, to_process)
+
+        return entry
+
+    def get_logs(self) -> Step:
+        """Gets the logs in a hierarchical structure
+
+        Returns:
+            Step: The root element of the log hierarchy
+        """
+        project = self.build.project.name
+        build_id = self.build.id
+        steps = [
+            Build.Step(r)
+            for r in self.client.get_build_timeline(project, build_id).records
+        ]
+        root = [s for s in steps if not s.parent_id]
+        assert len(root) == 1, root
+        root = root[0]
+        steps.remove(root)
+        return self.__add_steps_and_logs(root, steps)

devopsdriver-0.1.45/devopsdriver/azdo/builds/client.py

@@ -0,0 +1,59 @@
+#!/usr/bin/env python3
+
+
+""" Azure Build Client """
+
+
+from datetime import datetime
+from azure.devops.v7_1.build import BuildClient
+
+from .build import Build
+
+
+class Client:  # pylint: disable=too-few-public-methods
+    """The Build client"""
+
+    def __init__(self, client: BuildClient):
+        self.client = client
+
+    def list(  # pylint: disable=too-many-arguments
+        self,
+        project: str,
+        pipelines: list[int] = None,
+        start: datetime = None,
+        end: datetime = None,
+        status: str = None,
+        result: str = None,
+        properties: list[str] = None,
+        branch: str = None,
+    ) -> list[Build]:
+        """Get the list of builds
+
+        Args:
+            project (str): The name of the project
+            pipelines (list[int], optional): List of pipeline ids. Defaults to None.
+            start (datetime, optional): Earliest time. Defaults to None.
+            end (datetime, optional): Latest time. Defaults to None.
+            status (str, optional): The status to get. Defaults to None.
+            result (str, optional): The result to get. Defaults to None.
+            properties (list[str], optional): List or properties to return. Defaults to None.
+            branch (str, optional): The branch to search. Defaults to None.
+
+        Returns:
+            list[Build]: List of all the builds that match the given criteria
+        """
+        continuation = None
+        return [
+            Build(self.client, b)
+            for b in self.client.get_builds(
+                project,
+                continuation_token=continuation,
+                definitions=pipelines,
+                min_time=start,
+                max_time=end,
+                status_filter=status,
+                result_filter=result,
+                properties=properties,
+                branch_name=branch,
+            )
+        ]

{devopsdriver-0.1.44 → devopsdriver-0.1.45}/devopsdriver/azdo/clients.py

@@ -14,6 +14,7 @@ from msrest.authentication import BasicAuthentication as MSBasicAuthentication
 from devopsdriver.settings import Settings
 from devopsdriver.azdo.workitem.client import Client as WIClient
 from devopsdriver.azdo.pipeline.client import Client as PLClient
+from devopsdriver.azdo.builds.client import Client as BClient
 
 
 # for testing
@@ -60,7 +61,7 @@ class Azure:  # pylint: disable=too-few-public-methods,too-many-instance-attribu
         self.core = Azure._Client(Azure.__client("core", clients, client_calls))
         self.task = Azure._Client(Azure.__client("task", clients, client_calls))
         self.git = Azure._Client(Azure.__client("git", clients, client_calls))
-        self.build = Azure._Client(Azure.__client("build", clients, client_calls))
+        self.build = BClient(Azure.__client("build", clients, client_calls))
         self.identity = Azure._Client(Azure.__client("identity", clients, client_calls))
 
     @staticmethod

{devopsdriver-0.1.44 → devopsdriver-0.1.45}/devopsdriver/dataobject.py

@@ -3,6 +3,9 @@
 """ Data Objects """
 
 
+from json import dumps
+
+
 class DataObject:  # pylint: disable=too-few-public-methods
     """dict like object with fuzzy field matching"""
 
@@ -46,6 +49,12 @@ class DataObject:  # pylint: disable=too-few-public-methods
     def __getattr__(self, name: str) -> any:
         return self._get_field(name, self.data)
 
+    def __str__(self) -> str:
+        return dumps(self.data, indent=2)
+
+    def __repr__(self) -> str:
+        return dumps(self.data, indent=2)
+
     class _Dict(dict):
         def __init__(self, dataobject, data: dict):
             self.dataobject = dataobject

{devopsdriver-0.1.44 → devopsdriver-0.1.45}/devopsdriver.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: devopsdriver
-Version: 0.1.44
+Version: 0.1.45
 Summary: DevOps tools
 Author-email: Marc Page <marcallenpage@gmail.com>
 License: This is free and unencumbered software released into the public domain.
@@ -40,7 +40,7 @@ Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: The Unlicense (Unlicense)
-Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.10
 Classifier: Topic :: Utilities
 Classifier: Topic :: Software Development
 Requires-Python: >=3.10
@@ -48,9 +48,9 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML==6.0.1
 Requires-Dist: keyring==25.1.0
-Requires-Dist: setuptools==69.2.0
+Requires-Dist: setuptools==69.5.1
 Requires-Dist: azure-devops==7.1.0b4
-Requires-Dist: Mako==1.3.2
+Requires-Dist: Mako==1.3.3
 Provides-Extra: dev
 Requires-Dist: black>=24.3.0; extra == "dev"
 Requires-Dist: pylint>=3.1.0; extra == "dev"
@@ -60,7 +60,7 @@ Requires-Dist: coverage>=7.4.4; extra == "test"
 Provides-Extra: doc
 
 ![status sheild](https://img.shields.io/static/v1?label=status&message=beta&color=blue&style=plastic)
-[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.44&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.44/)
+[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.45&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.45/)
 [![GitHub](https://img.shields.io/github/license/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver?tab=Unlicense-1-ov-file#readme)
 [![GitHub contributors](https://img.shields.io/github/contributors/marcpage/devops-driver?style=flat)](https://github.com/marcpage/devops-driver/graphs/contributors)
 [![PR's Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)

{devopsdriver-0.1.44 → devopsdriver-0.1.45}/devopsdriver.egg-info/SOURCES.txt

@@ -17,6 +17,9 @@ devopsdriver/azdo/__init__.py
 devopsdriver/azdo/azureobject.py
 devopsdriver/azdo/clients.py
 devopsdriver/azdo/timestamp.py
+devopsdriver/azdo/builds/__init__.py
+devopsdriver/azdo/builds/build.py
+devopsdriver/azdo/builds/client.py
 devopsdriver/azdo/pipeline/__init__.py
 devopsdriver/azdo/pipeline/client.py
 devopsdriver/azdo/pipeline/log.py
@@ -27,6 +30,8 @@ devopsdriver/azdo/workitem/client.py
 devopsdriver/azdo/workitem/wiql.py
 devopsdriver/templates/manage_settings.txt.mako
 tests/test_azure_azureobject.py
+tests/test_azure_build.py
+tests/test_azure_build_client.py
 tests/test_azure_clients.py
 tests/test_azure_pipeline.py
 tests/test_azure_pipeline_client.py

{devopsdriver-0.1.44 → devopsdriver-0.1.45}/devopsdriver.egg-info/requires.txt

@@ -1,8 +1,8 @@
 PyYAML==6.0.1
 keyring==25.1.0
-setuptools==69.2.0
+setuptools==69.5.1
 azure-devops==7.1.0b4
-Mako==1.3.2
+Mako==1.3.3
 
 [dev]
 black>=24.3.0

{devopsdriver-0.1.44 → devopsdriver-0.1.45}/pyproject.toml

@@ -8,9 +8,9 @@ requires-python = ">= 3.10"
 dependencies = [
   "PyYAML==6.0.1",
   "keyring==25.1.0",
-  "setuptools==69.2.0",  # neded for azure-devops to use 7.1 API
+  "setuptools==69.5.1",  # neded for azure-devops to use 7.1 API
   "azure-devops==7.1.0b4",
-  "Mako==1.3.2",
+  "Mako==1.3.3",
 ]
 keywords = ["azure", "devops", "jira", "confluence", "email", "pipelines", "tools"]
 classifiers=[
@@ -20,7 +20,7 @@ classifiers=[
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
     "License :: OSI Approved :: The Unlicense (Unlicense)",
-    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.10",
     "Topic :: Utilities",
     "Topic :: Software Development",
 ]

devopsdriver-0.1.45/tests/test_azure_build.py

@@ -0,0 +1,99 @@
+#!/usr/bin/env python3
+
+""" Test build object """
+
+from types import SimpleNamespace
+
+from devopsdriver.azdo.builds.build import Build
+from devopsdriver.azdo.azureobject import AzureObject
+
+
+class MockTimeline:  # pylint: disable=too-few-public-methods
+    """mock timeline"""
+
+    def __init__(self, d: dict):
+        self.d = d
+
+    def as_dict(self) -> dict:
+        """mock as_dict"""
+        return self.d
+
+
+class MockClient:
+    """mock build client"""
+
+    def get_build_log_lines(self, project, build_id, log_id) -> list[str]:
+        """mock get_build_log_lines"""
+        return [f"project={project}", f"build={build_id}", f"log={log_id}"]
+
+    def get_build_timeline(self, project, build_id):
+        """mock get_build_timeline"""
+        return SimpleNamespace(
+            records=[
+                MockTimeline(
+                    {
+                        "parent_id": None,
+                        "id": "5",
+                        "project": project,
+                        "build_id": build_id,
+                        "log": {"id": 9},
+                    }
+                ),
+                MockTimeline(
+                    {
+                        "parent_id": "5",
+                        "id": "6",
+                        "project": project,
+                        "build_id": build_id,
+                        "log": {"id": 6},
+                    }
+                ),
+            ]
+        )
+
+
+class MockBuild(AzureObject):  # pylint: disable=too-few-public-methods
+    """mock build client"""
+
+    def __init__(self, d: dict):
+        self.d = d
+        super().__init__(self)
+
+    def as_dict(self) -> dict:
+        """mock as_dict"""
+        return self.d
+
+
+def test_basic() -> None:
+    """test basic functionailty"""
+    build = Build(MockClient(), MockBuild({"project": {"name": "project"}, "id": 12}))
+    logs = build.get_logs().all_logs()
+    assert len(logs) == 2, logs
+
+
+def test_azure_object() -> None:
+    """test string conversions for data objects"""
+    build = MockBuild({"project": {"name": "project"}, "id": 12})
+    assert (
+        str(build)
+        == """{
+  "project": {
+    "name": "project"
+  },
+  "id": 12
+}"""
+    ), str(build)
+    assert (
+        repr(build)
+        == """{
+  "project": {
+    "name": "project"
+  },
+  "id": 12
+}"""
+    ), repr(build)
+
+
+if __name__ == "__main__":
+    test_basic()
+    test_azure_object()

devopsdriver-0.1.45/tests/test_azure_build_client.py

@@ -0,0 +1,76 @@
+#!/usr/bin/env python3
+
+""" Test azure build client """
+
+from datetime import datetime
+
+from devopsdriver.azdo.builds.client import Client
+
+
+class MockObject:
+    """mock object"""
+
+    def __init__(self, d: dict):
+        self.d = d
+
+    def as_dict(self) -> dict:
+        """mock as_dict
+
+        Returns:
+            dict: the dict
+        """
+        return self.d
+
+
+class MockClient:
+    """mock build client"""
+
+    def get_builds(
+        self,
+        project,
+        definitions,
+        min_time,
+        max_time,
+        status_filter,
+        result_filter,
+        properties,
+        branch_name,
+        continuation_token=None,
+    ):
+        """mock get_builds"""
+        return [
+            MockObject(
+                {
+                    "project": project,
+                    "pipelines": definitions,
+                    "start": min_time,
+                    "end": max_time,
+                    "status": status_filter,
+                    "result": result_filter,
+                    "fields": properties,
+                    "branch": branch_name,
+                    "token": continuation_token,
+                }
+            )
+        ]
+
+
+def test_basic() -> None:
+    """Test basic functionality"""
+    client = Client(MockClient())
+    results = client.list(
+        "project",
+        [1, 2, 3],
+        datetime.now(),
+        datetime.now(),
+        "completed",
+        "success",
+        ["id"],
+        "main",
+    )
+    assert len(results) == 1, results
+    assert results[0].project == "project"
+
+
+if __name__ == "__main__":
+    test_basic()