Release v1.1.0

.github/scripts/compatibility_api_test_5.py

@@ -9,7 +9,7 @@
 import unittest
 
 sys.path.append('.')
-from zabbix_utils.getter import Getter
+from zabbix_utils.getter import Getter, AgentResponse
 from zabbix_utils.api import ZabbixAPI, APIVersion
 from zabbix_utils.sender import ItemValue, Sender, TrapperResponse
 from zabbix_utils.exceptions import APIRequestError, APINotSupported
@@ -160,13 +160,18 @@ def test_send_values(self):
             ItemValue(self.hostname, self.itemkey, 0, 1695713666, 100),
             ItemValue(self.hostname, self.itemkey, 5.5, 1695713666)
         ]
-        resp = list(self.sender.send(items).values())[0]
-
+        resp = self.sender.send(items)
         self.assertEqual(type(resp), TrapperResponse, "Sending item values was going wrong")
         self.assertEqual(resp.total, len(items), "Total number of the sent values is unexpected")
         self.assertEqual(resp.processed, 4, "Number of the processed values is unexpected")
         self.assertEqual(resp.failed, (resp.total - resp.processed), "Number of the failed values is unexpected")
 
+        first_chunk = list(resp.details.values())[0][0]
+        self.assertEqual(type(first_chunk), TrapperResponse, "Sending item values was going wrong")
+        self.assertEqual(first_chunk.total, len(items), "Total number of the sent values is unexpected")
+        self.assertEqual(first_chunk.processed, 4, "Number of the processed values is unexpected")
+        self.assertEqual(first_chunk.failed, (first_chunk.total - first_chunk.processed), "Number of the failed values is unexpected")
+
 
 class CompatibilityGetTest(unittest.TestCase):
     """Compatibility test with Zabbix get version 5.0"""
@@ -185,7 +190,8 @@ def test_get_values(self):
         resp = self.agent.get('system.uname')
 
         self.assertIsNotNone(resp, "Getting item values was going wrong")
-        self.assertEqual(type(resp), str, "Got value is unexpected")
+        self.assertEqual(type(resp), AgentResponse, "Got value is unexpected")
+        self.assertEqual(type(resp.value), str, "Got value is unexpected")
 
 
 if __name__ == '__main__':

.github/scripts/compatibility_api_test_6.py

@@ -9,7 +9,7 @@
 import unittest
 
 sys.path.append('.')
-from zabbix_utils.getter import Getter
+from zabbix_utils.getter import Getter, AgentResponse
 from zabbix_utils.exceptions import APIRequestError
 from zabbix_utils.api import ZabbixAPI, APIVersion
 from zabbix_utils.sender import ItemValue, Sender, TrapperResponse
@@ -192,13 +192,18 @@ def test_send_values(self):
             ItemValue(self.hostname, self.itemkey, 0, 1695713666, 100),
             ItemValue(self.hostname, self.itemkey, 5.5, 1695713666)
         ]
-        resp = list(self.sender.send(items).values())[0]
-
+        resp = self.sender.send(items)
         self.assertEqual(type(resp), TrapperResponse, "Sending item values was going wrong")
         self.assertEqual(resp.total, len(items), "Total number of the sent values is unexpected")
         self.assertEqual(resp.processed, 4, "Number of the processed values is unexpected")
         self.assertEqual(resp.failed, (resp.total - resp.processed), "Number of the failed values is unexpected")
 
+        first_chunk = list(resp.details.values())[0][0]
+        self.assertEqual(type(first_chunk), TrapperResponse, "Sending item values was going wrong")
+        self.assertEqual(first_chunk.total, len(items), "Total number of the sent values is unexpected")
+        self.assertEqual(first_chunk.processed, 4, "Number of the processed values is unexpected")
+        self.assertEqual(first_chunk.failed, (first_chunk.total - first_chunk.processed), "Number of the failed values is unexpected")
+
 
 class CompatibilityGetTest(unittest.TestCase):
     """Compatibility test with Zabbix get version 6.0"""
@@ -217,7 +222,8 @@ def test_get_values(self):
         resp = self.agent.get('system.uname')
 
         self.assertIsNotNone(resp, "Getting item values was going wrong")
-        self.assertEqual(type(resp), str, "Got value is unexpected")
+        self.assertEqual(type(resp), AgentResponse, "Got value is unexpected")
+        self.assertEqual(type(resp.value), str, "Got value is unexpected")
 
 
 if __name__ == '__main__':

.github/scripts/compatibility_api_test_latest.py

@@ -9,7 +9,7 @@
 import unittest
 
 sys.path.append('.')
-from zabbix_utils.getter import Getter
+from zabbix_utils.getter import Getter, AgentResponse
 from zabbix_utils.exceptions import APIRequestError
 from zabbix_utils.api import ZabbixAPI, APIVersion
 from zabbix_utils.sender import ItemValue, Sender, TrapperResponse
@@ -204,13 +204,18 @@ def test_send_values(self):
             ItemValue(self.hostname, self.itemkey, 0, 1695713666, 100),
             ItemValue(self.hostname, self.itemkey, 5.5, 1695713666)
         ]
-        resp = list(self.sender.send(items).values())[0]
-
+        resp = self.sender.send(items)
         self.assertEqual(type(resp), TrapperResponse, "Sending item values was going wrong")
         self.assertEqual(resp.total, len(items), "Total number of the sent values is unexpected")
         self.assertEqual(resp.processed, 4, "Number of the processed values is unexpected")
         self.assertEqual(resp.failed, (resp.total - resp.processed), "Number of the failed values is unexpected")
 
+        first_chunk = list(resp.details.values())[0][0]
+        self.assertEqual(type(first_chunk), TrapperResponse, "Sending item values was going wrong")
+        self.assertEqual(first_chunk.total, len(items), "Total number of the sent values is unexpected")
+        self.assertEqual(first_chunk.processed, 4, "Number of the processed values is unexpected")
+        self.assertEqual(first_chunk.failed, (first_chunk.total - first_chunk.processed), "Number of the failed values is unexpected")
+
 
 class CompatibilityGetTest(unittest.TestCase):
     """Compatibility test with the latest Zabbix get version"""
@@ -229,7 +234,8 @@ def test_get_values(self):
         resp = self.agent.get('system.uname')
 
         self.assertIsNotNone(resp, "Getting item values was going wrong")
-        self.assertEqual(type(resp), str, "Got value is unexpected")
+        self.assertEqual(type(resp), AgentResponse, "Got value is unexpected")
+        self.assertEqual(type(resp.value), str, "Got value is unexpected")
 
 
 if __name__ == '__main__':

.github/scripts/integration_get_test.py

@@ -30,7 +30,7 @@ def test_get(self):
 
         self.assertIsNotNone(resp, "Getting item values was going wrong")
         try:
-            resp_list = json.loads(resp)
+            resp_list = json.loads(resp.value)
         except json.decoder.JSONDecodeError:
             self.fail(f"raised unexpected Exception while parsing response: {resp}")
 

.github/scripts/integration_sender_test.py

@@ -34,17 +34,18 @@ def test_send(self):
             ItemValue('host3', 'item.key1', '{"msg":"test message"}'),
             ItemValue('host2', 'item.key1', 0, 1695713666, 100)
         ]
-        responses = self.sender.send(items)
+        response = self.sender.send(items)
 
-        self.assertEqual(type(responses), dict, "Sending item values was going wrong")
-        for node, resp in responses.items():
+        self.assertEqual(type(response.details), dict, "Sending item values was going wrong")
+        for node, resp in response.details.items():
             self.assertEqual(type(node), Node, "Sending item values was going wrong")
-            self.assertEqual(type(resp), TrapperResponse, "Sending item values was going wrong")
-            for key in ('processed', 'failed', 'total', 'time', 'chunk'):
-                try:
-                    self.assertIsNotNone(getattr(resp, key), f"There aren't expected '{key}' value")
-                except AttributeError:
-                    self.fail(f"raised unexpected Exception for attribute: {key}")
+            for item in resp:
+                self.assertEqual(type(item), TrapperResponse, "Sending item values was going wrong")
+                for key in ('processed', 'failed', 'total', 'time', 'chunk'):
+                    try:
+                        self.assertIsNotNone(getattr(item, key), f"There aren't expected '{key}' value")
+                    except AttributeError:
+                        self.fail(f"raised unexpected Exception for attribute: {key}")
 
 
 if __name__ == '__main__':

.github/workflows/coverage.yaml

@@ -2,10 +2,10 @@ name: coverage
 run-name: Check test coverage
 
 on:
-  #push:
-  #  branches: [main]
-  #pull_request:
-  #  branches: [main]
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
   workflow_dispatch:
 
 jobs:

.github/workflows/integration_api.yaml

@@ -2,10 +2,14 @@ name: api
 run-name: Run Zabbix API integration test
 
 on:
-  #push:
-  #  branches: [main]
-  #pull_request:
-  #  branches: [main]
+  push:
+    branches: [main]
+    paths:
+      - '**api.py'
+  pull_request:
+    branches: [main]
+    paths:
+      - '**api.py'
   workflow_dispatch:
 
 env:

.github/workflows/integration_get.yaml

@@ -2,10 +2,14 @@ name: get
 run-name: Run Zabbix get integration test
 
 on:
-  #push:
-  #  branches: [main]
-  #pull_request:
-  #  branches: [main]
+  push:
+    branches: [main]
+    paths:
+      - '**get.py'
+  pull_request:
+    branches: [main]
+    paths:
+      - '**get.py'
   workflow_dispatch:
 
 env:

.github/workflows/integration_sender.yaml

@@ -2,10 +2,14 @@ name: sender
 run-name: Run Zabbix sender integration test
 
 on:
-  #push:
-  #  branches: [main]
-  #pull_request:
-  #  branches: [main]
+  push:
+    branches: [main]
+    paths:
+      - '**sender.py'
+  pull_request:
+    branches: [main]
+    paths:
+      - '**sender.py'
   workflow_dispatch:
 
 env:

.github/workflows/release.yaml

@@ -0,0 +1,69 @@
+name: release
+run-name: Release new version
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - '**version.py'
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+      - name: Get pip cache
+        id: pip-cache
+        run: |
+          python -c "from pip._internal.locations import USER_CACHE_DIR; print('dir=' + USER_CACHE_DIR)" >> $GITHUB_OUTPUT
+      - uses: actions/cache@v3
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip
+      - name: Install build requirements
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel
+          pip install -r ./requirements.txt
+      - name: Set version env
+        run: |
+          echo "LIBRARY_VERSION=$(python -c "import sys; sys.path.append('.'); from zabbix_utils.version import __version__; print(__version__)")" >> $GITHUB_ENV
+      - name: Build packages
+        run: |
+          python setup.py sdist bdist_wheel
+      - name: Add version tag
+        uses: pkgdeps/git-tag-action@v2
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          github_repo: ${{ github.repository }}
+          git_commit_sha: ${{ github.sha }}
+          version: ${{ env.LIBRARY_VERSION }}
+          git_tag_prefix: "v"
+      - name: Archive built packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: Archive-v${{ env.LIBRARY_VERSION }}
+          path: dist/*
+      - name: Create release notes
+        run: |
+          grep -Pzo '(?s)^## \[${{ env.LIBRARY_VERSION }}\].*?(?=## \[)' CHANGELOG.md | sed '$ s/.$//' > RELEASE_NOTES.md
+          sed -i 's/\[${{ env.LIBRARY_VERSION }}\]/Release [v${{ env.LIBRARY_VERSION }}]/' RELEASE_NOTES.md
+      - name: Create release
+        uses: ncipollo/release-action@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          name: v${{ env.LIBRARY_VERSION }}
+          draft: true
+          prerelease: false
+          makeLatest: true
+          skipIfReleaseExists: true
+          replacesArtifacts: true
+          removeArtifacts: true
+          tag: "v${{ env.LIBRARY_VERSION }}"
+          bodyFile: RELEASE_NOTES.md
+          artifacts: dist/*

CHANGELOG.md

@@ -1,3 +1,20 @@
+## [1.1.0](https://github.com/zabbix/python-zabbix-utils/compare/v1.0.3...v1.1.0) (2024-01-23)
+
+### Breaking Changes: 
+
+- changed the format of the Sender response
+- changed the format of the Getter response
+
+### Features:
+
+- implemented support for specifying Zabbix clusters in Sender
+- implemented pre-processing of the agent response
+
+### Bug fixes:
+
+- fixed issue with hiding private (sensitive) fields in the log
+- fixed small bugs and flaws
+
 ## [1.0.3](https://github.com/zabbix/python-zabbix-utils/compare/v1.0.2...v1.0.3) (2024-01-09)
 
 ### Documentation