Ciac 11100 playbook run in build #4658

JasBeilin · 2024-11-12T08:40:55Z

Added test-use-case command, to run use case flows on cloud machines.

Related Issues

fixes: https://jira-dc.paloaltonetworks.com/browse/CIAC-11867

…00-playbook-run-in-build

… of github.com:demisto/demisto-sdk into CIAC-11868-adding-fixtures-and-abilities-to-flow-tests

… of github.com:demisto/demisto-sdk into CIAC-11100-playbook-run-in-build

…00-playbook-run-in-build

dantavori

some minor comments but looks very good!

dantavori · 2025-01-02T07:26:02Z

.changelog/4658.yml

@@ -0,0 +1,4 @@
+changes:
+- description: Adding new command **test-use-case** to test use case flows on cloud machines.


Suggested change

- description: Adding new command **test-use-case** to test use case flows on cloud machines.

- description: Added the **test-use-case** command to test use-case flows on cloud machines.

dantavori · 2025-01-02T07:29:04Z

demisto_sdk/commands/common/clients/__init__.py

@@ -132,6 +133,7 @@ def get_client_from_server_type(
    auth_id: Optional[str] = None,
    username: Optional[str] = None,
    password: Optional[str] = None,
+    lcas_id: Optional[str] = None,


Suggested change

lcas_id: Optional[str] = None,

lcaas_id: Optional[str] = None,

I'd go with "project_id", quicker to understand than the ugly devops term "lcaas", but not super critical

dantavori · 2025-01-02T07:30:53Z

demisto_sdk/commands/common/clients/__init__.py

+    # Manually parse command-line argument
+    for arg in request.config.invocation_params.args:
+        if isinstance(arg, str) and arg.startswith("--client_conf="):
+            logger.info("there is --client_conf recognized")


Suggested change

logger.info("there is --client_conf recognized")

logger.debug("Parsing --client_conf argument")

dantavori · 2025-01-02T08:18:27Z

demisto_sdk/commands/common/clients/xsiam/xsiam_api_client.py

+    """
+
+    def _process_response(self, response, status_code, expected_status=200):
+        """Process the HTTP response coming from the XSOAR client."""


Suggested change

"""Process the HTTP response coming from the XSOAR client."""

"""Process the HTTP response coming from the XSIAM client."""

dantavori · 2025-01-02T08:20:50Z

demisto_sdk/commands/common/constants.py

@@ -2218,3 +2219,4 @@ class PlaybookTaskType(StrEnum):
 # Test types:
 TEST_PLAYBOOKS = "TestPlaybooks"
 TEST_MODELING_RULES = "TestModelingRules"
+Test_Use_Cases = "TestUseCases"


Suggested change

Test_Use_Cases = "TestUseCases"

TEST_USE_CASES = "TestUseCases"

dantavori · 2025-01-05T13:18:58Z

pyproject.toml

@@ -126,6 +126,7 @@ pytest-github-actions-annotate-failures = "^0.2.0"
 pytest-sugar = "^1.0.0"
 pytest-loguru = "^0.4.0"

+


if there's no change then we can revert the changes in both poetry files

dantavori · 2025-01-05T13:24:06Z

demisto_sdk/commands/test_content/test_use_case/test_use_case.py

+        logging_module.info("Start uploading test use case results file to bucket")
+
+        storage_client = storage.Client.from_service_account_json(self.service_account)
+        storage_bucket = storage_client.bucket(self.artifacts_bucket)
+
+        blob = storage_bucket.blob(
+            f"content-test-use-case/{repository_name}/{file_name}"
+        )
+        blob.upload_from_filename(
+            original_file_path.as_posix(),
+            content_type="application/xml",
+        )
+
+        logging_module.info("Finished uploading test use case results file to bucket")


Suggested change

logging_module.info("Start uploading test use case results file to bucket")

storage_client = storage.Client.from_service_account_json(self.service_account)

storage_bucket = storage_client.bucket(self.artifacts_bucket)

blob = storage_bucket.blob(

f"content-test-use-case/{repository_name}/{file_name}"

)

blob.upload_from_filename(

original_file_path.as_posix(),

content_type="application/xml",

)

logging_module.info("Finished uploading test use case results file to bucket")

logging_module.debug("Start uploading test use case results file to bucket")

storage_client = storage.Client.from_service_account_json(self.service_account)

storage_bucket = storage_client.bucket(self.artifacts_bucket)

blob = storage_bucket.blob(

f"content-test-use-case/{repository_name}/{file_name}"

)

blob.upload_from_filename(

original_file_path.as_posix(),

content_type="application/xml",

)

logging_module.debug("Finished uploading test use case results file to bucket")

dantavori · 2025-01-05T13:26:04Z

demisto_sdk/commands/test_content/test_use_case/test_use_case.py

+
+        # --------------------------- Env Setup -------------------------------
+
+        logger.info("installing pyxdr...")


Suggested change

logger.info("installing pyxdr...")

logger.debug("installing pyxdr...")

generally go over everything and ensure logs are info only for "user messages" and not for "developer messages"
I recommend reading the job logs in the gitlab UI to easily understand which info logs we actually want to be debug

dantavori · 2025-01-05T13:29:10Z

demisto_sdk/commands/test_content/test_use_case/test_use_case.py

+        except Exception:
+            self.build_context.logging_module.exception("~~ Thread failed ~~")
+            self.build_context.tests_data_keeper.errors = True


how does it behave in case of exception?

will the rest of the threads continue?

will we see the error message?

yes, each thread should run its tests, the rest of the threads should keep running.
Also logs per thread are printed (with thread number)

dantavori · 2025-01-05T13:40:22Z

demisto_sdk/commands/test_content/test_use_case/tests/test_use_case_test.py

can we have one sanity E2E test (from the main command method)?

Shellyber · 2025-01-06T13:43:36Z

demisto_sdk/commands/test_content/test_use_case/test_use_case.py

Please update the file_name to end with _setup.py at the end.
Also, keep the logic of the command options here and then the call to the command itself.
The rest of the code - should be in a different file (the logic should be in a different file) - see examples in the other SDK commands (upload, download etc)

JasBeilin added 5 commits November 10, 2024 15:16

added alerts functionality

265b6e1

wip

03a494e

wip

30b9120

Merge branch 'master' of github.com:demisto/demisto-sdk into CIAC-111…

0df0342

…00-playbook-run-in-build

remove not needed code

c0a375c

JasBeilin self-assigned this Nov 12, 2024

JasBeilin requested a review from samuelFain as a code owner November 12, 2024 08:40

JasBeilin marked this pull request as draft November 12, 2024 08:41

JasBeilin and others added 22 commits November 18, 2024 10:20

added sdk handling

925ef3d

added running pytest with args

41b5444

WIP

554ce44

added template file

06b02da

wip

b0ee17a

wip

1319502

add changelog

c33ac6e

mypy

e6e9db1

Update and rename 6669.yml to 4650.yml

b83b9b7

wip

4726b59

Merge branch 'CIAC-11868-adding-fixtures-and-abilities-to-flow-tests'…

7b69bda

… of github.com:demisto/demisto-sdk into CIAC-11868-adding-fixtures-and-abilities-to-flow-tests

test xdr client

1208413

test xdr client

e6e9eb6

test xdr client

8893847

bug fix

45907d1

test

7fbff0b

adding command logic

0e0e8e4

Merge branch 'CIAC-11868-adding-fixtures-and-abilities-to-flow-tests'…

972981f

… of github.com:demisto/demisto-sdk into CIAC-11100-playbook-run-in-build

Merge branch 'master' of github.com:demisto/demisto-sdk into CIAC-111…

1c94842

…00-playbook-run-in-build

added new version of the commands playbook flow according to new schema

b14d562

order and removing modeling

d1d286c

fix

3bbbb7d

eyalpalo added 15 commits December 18, 2024 10:48

xsoar 8 support

0d308cc

fix

0e4e193

moved methods and renamed test file

7328074

changed use test case

e248a06

added search alert by name

cc9544f

pre commit

cdef090

fix unit test

0ce3da0

added search by uuid

7a75515

pre commit

952ebaf

Merge branch 'master' of github.com:demisto/demisto-sdk into CIAC-111…

aea4dce

…00-playbook-run-in-build

changelog

5454083

changelog

b6cffea

changelog

8804d27

Merge branch 'master' of github.com:demisto/demisto-sdk into CIAC-111…

5e1d5be

…00-playbook-run-in-build

lcas_id

7ded669

eyalpalo marked this pull request as ready for review December 31, 2024 09:23

eyalpalo requested a review from AradCarmi as a code owner December 31, 2024 09:23

pre-commit

be0a042

eyalpalo requested a review from dantavori December 31, 2024 09:24

eyalpalo assigned eyalpalo and unassigned JasBeilin Dec 31, 2024

eyalpalo added 5 commits January 1, 2025 10:32

added sanitize

6b47ee8

added filename

aa14934

poetry

3e852c8

poetry

c8d9fb8

poetry and installing the pyxdr

8e364b4

dantavori requested changes Jan 5, 2025

View reviewed changes

Shellyber reviewed Jan 6, 2025

View reviewed changes

eyalpalo added 2 commits January 6, 2025 16:54

code review

af45921

path

22b4fa8

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ciac 11100 playbook run in build #4658

Ciac 11100 playbook run in build #4658

JasBeilin commented Nov 12, 2024 •

edited by eyalpalo

Loading

dantavori left a comment

dantavori Jan 2, 2025

dantavori Jan 2, 2025

dantavori Jan 2, 2025

dantavori Jan 2, 2025

dantavori Jan 2, 2025

dantavori Jan 5, 2025

dantavori Jan 5, 2025

dantavori Jan 5, 2025

dantavori Jan 5, 2025

eyalpalo Jan 6, 2025

dantavori Jan 5, 2025

Shellyber Jan 6, 2025

		@@ -0,0 +1,4 @@
		changes:
		- description: Adding new command test-use-case to test use case flows on cloud machines.

	- description: Adding new command test-use-case to test use case flows on cloud machines.
	- description: Added the test-use-case command to test use-case flows on cloud machines.

	lcas_id: Optional[str] = None,
	lcaas_id: Optional[str] = None,

	logger.info("there is --client_conf recognized")
	logger.debug("Parsing --client_conf argument")

	"""Process the HTTP response coming from the XSOAR client."""
	"""Process the HTTP response coming from the XSIAM client."""

	Test_Use_Cases = "TestUseCases"
	TEST_USE_CASES = "TestUseCases"

		@@ -126,6 +126,7 @@ pytest-github-actions-annotate-failures = "^0.2.0"
		pytest-sugar = "^1.0.0"
		pytest-loguru = "^0.4.0"


		# --------------------------- Env Setup -------------------------------

		logger.info("installing pyxdr...")

	logger.info("installing pyxdr...")
	logger.debug("installing pyxdr...")

Ciac 11100 playbook run in build #4658

Are you sure you want to change the base?

Ciac 11100 playbook run in build #4658

Conversation

JasBeilin commented Nov 12, 2024 • edited by eyalpalo Loading

Related Issues

dantavori left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JasBeilin commented Nov 12, 2024 •

edited by eyalpalo

Loading