Created 3 tests for containers #4

Sacramento-20 · 2023-06-03T00:49:13Z

Created 3 tests for the containers for the three specified cases:

Container removed after n seconds.
Container with infinite execution removed after n seconds.
Container removed after returning an error.
solving Mock container execution to test failure modes #1

cunha

Please check comments inline. General suggestions:

Use linters to check code; address lints whenever possible.
Autoformat the code using black.
Do not keep commented-out code in the Pull Request; move documentation to a README file or proper comments.
Extend the module so Scout works by default (it's what the module will be used for)

scout/scout.py

cunha · 2023-06-04T17:13:00Z

scout/scout.py

-# https://docs.docker.com/engine/reference/commandline/ps/
-class ContainerState(enum.StrEnum):
+# # https://docs.docker.com/engine/reference/commandline/ps/
+class ContainerState(enum.Enum):


This is not equivalent to using StrEnum. Document that we should move to StrEnum if Python 3.11 is available.

StrEnum not compatible with the current version, the change will be included in the documentation.

cunha · 2023-06-04T17:13:44Z

scout/scout.py

@@ -34,17 +35,30 @@ class ContainerState(enum.StrEnum):
    def is_done(self):
        return self in [ContainerState.EXITED, ContainerState.DEAD]

+# Set de configuração do scout especificamente


Do not leave commented-out code in Pull Requests. Documentation should be written in comments, README files, the Wiki.

Removed code comment.

cunha · 2023-06-04T17:14:40Z

scout/scout.py


 @dataclasses.dataclass(frozen=True)
 class ScoutConfig:
    credentials_file: pathlib.Path
    output_dir: pathlib.Path
-    docker_image: str = "rossja/ncc-scoutsuite:aws-latest"
+    docker_image: str = "alpine"


This is the public interface of the proposed module. The default image should be Scout, not the testing image. The testing image should be set by the test code.

Corrected code, importing the scout image during module configuration.

cunha · 2023-06-04T18:12:57Z

scout/tests/testrun.py

+import argparse
+
+parser = argparse.ArgumentParser()
+parser.add_argument('-t1', '--task1', type=int ,help='Task 1')


Please give each test a mnemonic name (instead of numbers).

Alternatively, we can just run all tests every time.

Provided detailed actions for argparse. Initially, the tests are not executing together, but I will create a module for that.

cunha · 2023-06-04T18:14:24Z

scout/tests/testrun.py

@@ -17,14 +25,39 @@
 def callback(label: str, success: bool) -> None:
    logging.info("Callback for %s running, success=%s", label, success)

+def task_1(s, taskcfg, seconds: int):
+    task_generic_sleep = ["sleep", f'{1}']
+    logging.info("")


No empty lines and no ALL CAPS in the logs, please.

Line logging.info("") removed.

cunha · 2023-06-04T18:14:52Z

scout/tests/testrun.py

@@ -17,14 +25,39 @@
 def callback(label: str, success: bool) -> None:
    logging.info("Callback for %s running, success=%s", label, success)

+def task_1(s, taskcfg, seconds: int):
+    task_generic_sleep = ["sleep", f'{1}']


Please use linters to check for unnecessary complexity such as f"{1}".

cunha · 2023-06-04T18:16:16Z

scout/tests/testrun.py

+    task_generic_sleep = ["sleep", f'{1}']
+    logging.info("")
+    logging.info("RUNNING TASK 1")
+    s.enqueue(taskcfg, task_generic_sleep, seconds)


We should generate multiple test containers (5 is what I had planned in the issue). Also, sleep 1 is way faster and won't allow us to check whether code is correctly handling the containers.

Corrected and included in task_1.

cunha · 2023-06-04T18:18:11Z

scout/tests/testrun.py

+    s.shutdown(False)
+
+def task_3(s, taskcfg, seconds: int):
+    task_generic_error = ["sh", "-c", f'sleep {seconds}', "&&" , "exit", "1"]


The parameters to sh are -c and f"sleep {seconds} && exit 1", so the latter should be a single entry in the list. Replace exit 1 with false.

cunha

Please check comments inline. General suggestions:

Use linters to check code; address lints whenever possible.
Autoformat the code using black.
Do not keep commented-out code in the Pull Request; move documentation to a README file or proper comments.
Extend the module so Scout works by default (it's what the module will be used for)

cunha · 2023-06-17T13:47:34Z

scout/scout.py

@@ -39,7 +39,7 @@ def is_done(self):
 class ScoutConfig:
    credentials_file: pathlib.Path
    output_dir: pathlib.Path
-    docker_image: str = "rossja/ncc-scoutsuite:aws-latest"


We should keep the default image as the default value for docker_image. This can be overwritten in the tests as needed.

cunha · 2023-06-17T13:47:54Z

scout/scout.py

                outfp = self.config.output_dir / cfg.label
                with gzip.open(outfp / "result.json.gz", "wt", encoding="utf8") as fd:
                    json.dump(r, fd)
                self.task_completion_callback(cfg.label, True)
                logging.info(
-                    "Scout run completed, id %s status %d",
+                    "Scout run completed, id %s sta+-tus %d",


Resolved and will be included in the next commit.

refactor tests

Created 3 tests for containers

b11d5f5

Sacramento-20 requested a review from cunha June 3, 2023 00:49

cunha requested changes Jun 4, 2023

View reviewed changes

Sacramento-20 added 2 commits June 13, 2023 16:00

made pull request fixes

de2ff67

run black

0fa3a93

Sacramento-20 requested a review from cunha June 13, 2023 19:04

cunha requested changes Jun 17, 2023

View reviewed changes

Sacramento-20 and others added 3 commits June 17, 2023 18:19

Resolved excessive errors.

64f736b

refactor tests

9d34c13

Merge pull request #1 from TopologyMapping/pr/Sacramento-20/4

f57077b

refactor tests

cunha merged commit fa61c4d into TopologyMapping:main Jun 20, 2023

cunha deleted the branch_test_container branch June 20, 2023 16:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Created 3 tests for containers #4

Created 3 tests for containers #4

Sacramento-20 commented Jun 3, 2023 •

edited

Loading

cunha left a comment

cunha Jun 4, 2023

Sacramento-20 Jun 17, 2023

cunha Jun 4, 2023

Sacramento-20 Jun 17, 2023

cunha Jun 4, 2023

Sacramento-20 Jun 17, 2023

cunha Jun 4, 2023

cunha Jun 4, 2023

Sacramento-20 Jun 17, 2023

cunha Jun 4, 2023

Sacramento-20 Jun 17, 2023

cunha Jun 4, 2023

Sacramento-20 Jun 17, 2023

cunha Jun 4, 2023

Sacramento-20 Jun 17, 2023

cunha Jun 4, 2023

Sacramento-20 Jun 17, 2023

cunha left a comment

cunha Jun 17, 2023

Sacramento-20 Jun 17, 2023

cunha Jun 17, 2023

Sacramento-20 Jun 17, 2023

Created 3 tests for containers #4

Created 3 tests for containers #4

Conversation

Sacramento-20 commented Jun 3, 2023 • edited Loading

cunha 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

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

cunha 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

Sacramento-20 commented Jun 3, 2023 •

edited

Loading