From e2a4d8c661bde480a377a0df8b4b4e0790f08363 Mon Sep 17 00:00:00 2001 From: Abhi Shah Date: Fri, 7 Oct 2022 00:47:59 +0530 Subject: [PATCH 01/11] Update event_writer.py Updated file permissions --- splunklib/modularinput/event_writer.py | 0 1 file changed, 0 insertions(+), 0 deletions(-) mode change 100755 => 100644 splunklib/modularinput/event_writer.py diff --git a/splunklib/modularinput/event_writer.py b/splunklib/modularinput/event_writer.py old mode 100755 new mode 100644 From 1af8e4050e4923995b2ebb20401dd36a19a79188 Mon Sep 17 00:00:00 2001 From: Abhi Shah Date: Fri, 7 Oct 2022 12:31:48 +0530 Subject: [PATCH 02/11] test doc generation --- .github/workflows/release.yml | 19 ++++++++++--------- .github/workflows/test.yml | 2 +- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 4d11da591..7215383a2 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,7 +1,8 @@ name: Release on: - release: - types: [published] + [push] +# release: +# types: [published] jobs: publish: @@ -18,23 +19,23 @@ jobs: run: pip install twine - name: Build package run: python setup.py sdist - - name: Publish package to PyPI - uses: pypa/gh-action-pypi-publish@v1.3.1 - with: - user: __token__ - password: ${{ secrets.pypi_password }} +# - name: Publish package to PyPI +# uses: pypa/gh-action-pypi-publish@v1.3.1 +# with: +# user: __token__ +# password: ${{ secrets.pypi_password }} - name: Install tox run: pip install tox - name: Generate API docs run: | rm -rf ./docs/_build tox -e docs - cd ./docs/_build/html && zip -r ../docs_html.zip . -x ".*" -x "__MACOSX" +# cd ./docs/_build/html && zip -r ../docs_html.zip . -x ".*" -x "__MACOSX" - name : Docs Upload uses: actions/upload-artifact@v3 with: name: apidocs - path: docs/_build/docs_html.zip + path: docs/_build/html # Test upload # - name: Publish package to TestPyPI # uses: pypa/gh-action-pypi-publish@master diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 06278e298..be76ad2de 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,7 +1,7 @@ name: Python CI on: - [ push, pull_request ] + [pull_request ] jobs: build: From 7b43f525d591bac013cba66c6394bd707f4763c8 Mon Sep 17 00:00:00 2001 From: Abhi Shah Date: Fri, 7 Oct 2022 15:34:58 +0530 Subject: [PATCH 03/11] Update release.yml --- .github/workflows/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 7215383a2..1434d90a3 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -34,7 +34,7 @@ jobs: - name : Docs Upload uses: actions/upload-artifact@v3 with: - name: apidocs + name: python_sdk_docs path: docs/_build/html # Test upload # - name: Publish package to TestPyPI From 0b0f6492ea58d0b7cf3b2c6d26222ba4601acca7 Mon Sep 17 00:00:00 2001 From: Abhi Shah Date: Mon, 10 Oct 2022 11:55:18 +0530 Subject: [PATCH 04/11] revert workflow changes --- .gitconfig | 2 ++ .github/workflows/release.yml | 16 +++++++--------- .github/workflows/test.yml | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) create mode 100644 .gitconfig diff --git a/.gitconfig b/.gitconfig new file mode 100644 index 000000000..4f73bb61b --- /dev/null +++ b/.gitconfig @@ -0,0 +1,2 @@ +[core] + filemode = true \ No newline at end of file diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 1434d90a3..9309a3116 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,8 +1,7 @@ name: Release on: - [push] -# release: -# types: [published] + release: + types: [published] jobs: publish: @@ -19,18 +18,17 @@ jobs: run: pip install twine - name: Build package run: python setup.py sdist -# - name: Publish package to PyPI -# uses: pypa/gh-action-pypi-publish@v1.3.1 -# with: -# user: __token__ -# password: ${{ secrets.pypi_password }} + - name: Publish package to PyPI + uses: pypa/gh-action-pypi-publish@v1.3.1 + with: + user: __token__ + password: ${{ secrets.pypi_password }} - name: Install tox run: pip install tox - name: Generate API docs run: | rm -rf ./docs/_build tox -e docs -# cd ./docs/_build/html && zip -r ../docs_html.zip . -x ".*" -x "__MACOSX" - name : Docs Upload uses: actions/upload-artifact@v3 with: diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index be76ad2de..45af614a5 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,7 +1,7 @@ name: Python CI on: - [pull_request ] + [push, pull_request ] jobs: build: From b68b01475f26dae9fc02accaca6b03e8eba013c3 Mon Sep 17 00:00:00 2001 From: Abhi Shah Date: Mon, 10 Oct 2022 12:00:14 +0530 Subject: [PATCH 05/11] sync --- .gitconfig | 2 +- .github/workflows/test.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.gitconfig b/.gitconfig index 4f73bb61b..561dfa1d8 100644 --- a/.gitconfig +++ b/.gitconfig @@ -1,2 +1,2 @@ [core] - filemode = true \ No newline at end of file + filemode = false \ No newline at end of file diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 45af614a5..06278e298 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,7 +1,7 @@ name: Python CI on: - [push, pull_request ] + [ push, pull_request ] jobs: build: From 296c154b5b917f84d71c329fafbb3c66a00d92f6 Mon Sep 17 00:00:00 2001 From: Abhi Shah Date: Mon, 31 Oct 2022 16:04:33 +0530 Subject: [PATCH 06/11] Update test_utils.py added test case to check if any change in file-permission is made --- tests/test_utils.py | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/tests/test_utils.py b/tests/test_utils.py index 5b6b712ca..1db09b6b4 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -1,6 +1,9 @@ from __future__ import absolute_import from tests import testlib +import unittest +import os + try: from utils import * except ImportError: @@ -76,6 +79,27 @@ def test_dslice_all_args(self): } self.assertTrue(expected == dslice(TEST_DICT, *test_args)) +class FilePermissionTest(unittest.TestCase): + + def setUp(self): + super(FilePermissionTest, self).setUp() + + def test_filePermissions(self): + + def checkFilePermissions(dir_path): + for file in os.listdir(dir_path): + if file.__contains__('pycache'): + continue + path = os.path.join(dir_path, file) + if os.path.isfile(path): + permission = oct(os.stat(path).st_mode) + self.assertEqual(permission, '0o100644') + else: + checkFilePermissions(path) + + dir_path = os.path.join('..', 'splunklib') + checkFilePermissions(dir_path) + if __name__ == "__main__": try: From 968f01e29ea06614281bc960bf9a9255b1132df9 Mon Sep 17 00:00:00 2001 From: Abhi Shah Date: Mon, 31 Oct 2022 16:08:13 +0530 Subject: [PATCH 07/11] Delete .gitconfig --- .gitconfig | 2 -- 1 file changed, 2 deletions(-) delete mode 100644 .gitconfig diff --git a/.gitconfig b/.gitconfig deleted file mode 100644 index 561dfa1d8..000000000 --- a/.gitconfig +++ /dev/null @@ -1,2 +0,0 @@ -[core] - filemode = false \ No newline at end of file From af6826214035de7db1edbe539064c26e0038bb77 Mon Sep 17 00:00:00 2001 From: Abhi Shah Date: Fri, 4 Nov 2022 14:39:51 +0530 Subject: [PATCH 08/11] Update test_utils.py --- tests/test_utils.py | 62 +++++++++++++++++++++++---------------------- 1 file changed, 32 insertions(+), 30 deletions(-) diff --git a/tests/test_utils.py b/tests/test_utils.py index 1db09b6b4..2e6bae192 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -10,14 +10,14 @@ raise Exception("Add the SDK repository to your PYTHONPATH to run the test cases " "(e.g., export PYTHONPATH=~/splunk-sdk-python.") - TEST_DICT = { - 'username':'admin', - 'password':'changeme', - 'port' : 8089, - 'host' : 'localhost', - 'scheme': 'https' - } + 'username': 'admin', + 'password': 'changeme', + 'port': 8089, + 'host': 'localhost', + 'scheme': 'https' +} + class TestUtils(testlib.SDKTestCase): def setUp(self): @@ -26,16 +26,16 @@ def setUp(self): # Test dslice when a dict is passed to change key names def test_dslice_dict_args(self): args = { - 'username':'user-name', - 'password':'new_password', - 'port': 'admin_port', - 'foo':'bar' - } + 'username': 'user-name', + 'password': 'new_password', + 'port': 'admin_port', + 'foo': 'bar' + } expected = { - 'user-name':'admin', - 'new_password':'changeme', - 'admin_port':8089 - } + 'user-name': 'admin', + 'new_password': 'changeme', + 'admin_port': 8089 + } self.assertTrue(expected == dslice(TEST_DICT, args)) # Test dslice when a list is passed @@ -46,44 +46,46 @@ def test_dslice_list_args(self): 'port', 'host', 'foo' - ] + ] expected = { - 'username':'admin', - 'password':'changeme', - 'port':8089, - 'host':'localhost' - } + 'username': 'admin', + 'password': 'changeme', + 'port': 8089, + 'host': 'localhost' + } self.assertTrue(expected == dslice(TEST_DICT, test_list)) # Test dslice when a single string is passed def test_dslice_arg(self): test_arg = 'username' expected = { - 'username':'admin' - } + 'username': 'admin' + } self.assertTrue(expected == dslice(TEST_DICT, test_arg)) # Test dslice using all three types of arguments def test_dslice_all_args(self): test_args = [ - {'username':'new_username'}, + {'username': 'new_username'}, ['password', - 'host'], + 'host'], 'port' ] expected = { - 'new_username':'admin', - 'password':'changeme', - 'host':'localhost', - 'port':8089 + 'new_username': 'admin', + 'password': 'changeme', + 'host': 'localhost', + 'port': 8089 } self.assertTrue(expected == dslice(TEST_DICT, *test_args)) + class FilePermissionTest(unittest.TestCase): def setUp(self): super(FilePermissionTest, self).setUp() + # Check for any change in the default file permission(i.e 644) for all files within splunklib def test_filePermissions(self): def checkFilePermissions(dir_path): From a3588e039ff884b47c900d0bebb9344f8e1cfe08 Mon Sep 17 00:00:00 2001 From: Abhi Shah Date: Fri, 4 Nov 2022 17:35:36 +0530 Subject: [PATCH 09/11] Update test_utils.py --- tests/test_utils.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/tests/test_utils.py b/tests/test_utils.py index 2e6bae192..f0b39a1b9 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -3,6 +3,7 @@ import unittest import os +import sys try: from utils import * @@ -95,7 +96,10 @@ def checkFilePermissions(dir_path): path = os.path.join(dir_path, file) if os.path.isfile(path): permission = oct(os.stat(path).st_mode) - self.assertEqual(permission, '0o100644') + if sys.version_info >= (2, 7, 9): + self.assertEqual(permission, '0o100644') + else : + self.assertEqual(permission, '0100644') else: checkFilePermissions(path) From f1fea495d42b8aa3b5e283153c5ecff584daeb08 Mon Sep 17 00:00:00 2001 From: Abhi Shah Date: Fri, 4 Nov 2022 17:49:40 +0530 Subject: [PATCH 10/11] Update test_utils.py --- tests/test_utils.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_utils.py b/tests/test_utils.py index f0b39a1b9..1a3622960 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -96,7 +96,7 @@ def checkFilePermissions(dir_path): path = os.path.join(dir_path, file) if os.path.isfile(path): permission = oct(os.stat(path).st_mode) - if sys.version_info >= (2, 7, 9): + if sys.version_info > (2, 7, 9): self.assertEqual(permission, '0o100644') else : self.assertEqual(permission, '0100644') From 80a123c02075b91be8fc7139e7c2a1bc25fc333e Mon Sep 17 00:00:00 2001 From: Abhi Shah Date: Fri, 4 Nov 2022 18:03:06 +0530 Subject: [PATCH 11/11] Update test_utils.py --- tests/test_utils.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_utils.py b/tests/test_utils.py index 1a3622960..5eedbaba3 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -96,7 +96,7 @@ def checkFilePermissions(dir_path): path = os.path.join(dir_path, file) if os.path.isfile(path): permission = oct(os.stat(path).st_mode) - if sys.version_info > (2, 7, 9): + if sys.version_info >= (3, 0): self.assertEqual(permission, '0o100644') else : self.assertEqual(permission, '0100644')