From 11851c2a120a52d11fabadfd9f454be5f9b3e389 Mon Sep 17 00:00:00 2001 From: Artem Rys Date: Tue, 7 Sep 2021 17:11:39 +0200 Subject: [PATCH] feat: ucc-gen generates beautiful import_declare_test.py Run black and isort on import_declare_test.py. Adding a step in CI to verify styles. --- .github/workflows/build-test-release.yml | 19 +++++++++++++++++++ .../uccrestbuilder/global_config.py | 9 ++++----- .../bin/import_declare_test.py | 7 +++---- .../bin/import_declare_test.py | 7 +++---- 4 files changed, 29 insertions(+), 13 deletions(-) diff --git a/.github/workflows/build-test-release.yml b/.github/workflows/build-test-release.yml index 3bee6aef0..40a065934 100644 --- a/.github/workflows/build-test-release.yml +++ b/.github/workflows/build-test-release.yml @@ -131,6 +131,25 @@ jobs: with: app_path: tests/slimmed included_tags: ${{ matrix.tags }} + lint-expected-outputs: + # Only import_declare_test.py for now. + name: Lints expected_output_global_config_inputs_configuration_alerts folder generated by ucc-gen + runs-on: ubuntu-latest + continue-on-error: true + steps: + - uses: actions/checkout@v2 + - name: Setup python + uses: actions/setup-python@v2 + with: + python-version: "3.7" + - name: Install black + run: pip install black + - name: Install isort + run: pip install isort + - name: Run black + run: black --check tests/expected_output_global_config_inputs_configuration_alerts/Splunk_TA_UCCExample/bin/import_declare_test.py + - name: Run isort + run: isort --check tests/expected_output_global_config_inputs_configuration_alerts/Splunk_TA_UCCExample/bin/import_declare_test.py lint: runs-on: ubuntu-latest name: Lint Code Base diff --git a/splunk_add_on_ucc_framework/uccrestbuilder/global_config.py b/splunk_add_on_ucc_framework/uccrestbuilder/global_config.py index dac3c6e41..222aaeaa4 100644 --- a/splunk_add_on_ucc_framework/uccrestbuilder/global_config.py +++ b/splunk_add_on_ucc_framework/uccrestbuilder/global_config.py @@ -379,14 +379,13 @@ class GlobalConfigPostProcessor: import {import_declare_name} """ - _import_declare_content = """ -import os -import sys + _import_declare_content = """import os import re +import sys from os.path import dirname -ta_name = '{ta_name}' -pattern = re.compile(r'[\\\\/]etc[\\\\/]apps[\\\\/][^\\\\/]+[\\\\/]bin[\\\\/]?$') +ta_name = "{ta_name}" +pattern = re.compile(r"[\\\\/]etc[\\\\/]apps[\\\\/][^\\\\/]+[\\\\/]bin[\\\\/]?$") new_paths = [path for path in sys.path if not pattern.search(path) or ta_name in path] new_paths.append(os.path.join(dirname(dirname(__file__)), "lib")) new_paths.insert(0, os.path.sep.join([os.path.dirname(__file__), ta_name])) diff --git a/tests/expected_output_global_config_configuration/Splunk_TA_UCCExample/bin/import_declare_test.py b/tests/expected_output_global_config_configuration/Splunk_TA_UCCExample/bin/import_declare_test.py index 4d5010a49..052a41fb5 100644 --- a/tests/expected_output_global_config_configuration/Splunk_TA_UCCExample/bin/import_declare_test.py +++ b/tests/expected_output_global_config_configuration/Splunk_TA_UCCExample/bin/import_declare_test.py @@ -1,11 +1,10 @@ - import os -import sys import re +import sys from os.path import dirname -ta_name = 'Splunk_TA_UCCExample' -pattern = re.compile(r'[\\/]etc[\\/]apps[\\/][^\\/]+[\\/]bin[\\/]?$') +ta_name = "Splunk_TA_UCCExample" +pattern = re.compile(r"[\\/]etc[\\/]apps[\\/][^\\/]+[\\/]bin[\\/]?$") new_paths = [path for path in sys.path if not pattern.search(path) or ta_name in path] new_paths.append(os.path.join(dirname(dirname(__file__)), "lib")) new_paths.insert(0, os.path.sep.join([os.path.dirname(__file__), ta_name])) diff --git a/tests/expected_output_global_config_inputs_configuration_alerts/Splunk_TA_UCCExample/bin/import_declare_test.py b/tests/expected_output_global_config_inputs_configuration_alerts/Splunk_TA_UCCExample/bin/import_declare_test.py index 4d5010a49..052a41fb5 100644 --- a/tests/expected_output_global_config_inputs_configuration_alerts/Splunk_TA_UCCExample/bin/import_declare_test.py +++ b/tests/expected_output_global_config_inputs_configuration_alerts/Splunk_TA_UCCExample/bin/import_declare_test.py @@ -1,11 +1,10 @@ - import os -import sys import re +import sys from os.path import dirname -ta_name = 'Splunk_TA_UCCExample' -pattern = re.compile(r'[\\/]etc[\\/]apps[\\/][^\\/]+[\\/]bin[\\/]?$') +ta_name = "Splunk_TA_UCCExample" +pattern = re.compile(r"[\\/]etc[\\/]apps[\\/][^\\/]+[\\/]bin[\\/]?$") new_paths = [path for path in sys.path if not pattern.search(path) or ta_name in path] new_paths.append(os.path.join(dirname(dirname(__file__)), "lib")) new_paths.insert(0, os.path.sep.join([os.path.dirname(__file__), ta_name]))