diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3eb2729c558..3a3c7dda891 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -69,11 +69,11 @@ The PR ... * ... passes PR gating tests, or failing tests are waived in a comment by the reviewer explaining the reasoning. * ... adheres to the [coding style](docs/manual/developer/04_style_guide.md#complianceascode-style-guide). * ... has been tested. The following options allow for testing various aspects of the project: - * [SSG Test Suite](tests/README.md) for rule tests to ensure that OVAL checks are correct and test the ability of remediations to satisfy those checks. + * [Automatus](tests/README.md) for rule tests to ensure that OVAL checks are correct and test the ability of remediations to satisfy those checks. Every testable rule that is newly created or that just got modified has to have at least one test scenario. If a PR interacts with a testable rule without tests, the author shall supply a test scenario as part of the PR to get it merged. * [BATS framework](tests/unit/bash) for bash tests that allows for fast and exhaustive testing of remediations that are parametrized by Jinja2. - * [Unit tests](tests/unit) that test components of the build system as well as components of the SSG Test Suite. + * [Unit tests](tests/unit) that test components of the build system as well as components of the Automatus. * Ad-hoc tests that are integrated into the `ctest` chain directly, i.e. the shellcheck test. * ... updates READMEs, man pages or other documentation when changes of described behavior are introduced. * ... doesn't contain merge commits - those can be removed by rebasing. diff --git a/docs/index.rst b/docs/index.rst index c92be773bf5..a3a3e45b190 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -22,8 +22,8 @@ ComplianceAsCode/content .. toctree:: :maxdepth: 2 :glob: - :caption: Testing Content Using SSG Test Suite - :name: Testing Content Using SSG Test Suite + :caption: Testing Content Using Automatus + :name: Testing Content Using Automatus tests/README diff --git a/docs/manual/developer/02_building_complianceascode.md b/docs/manual/developer/02_building_complianceascode.md index a3109d9ea41..dd2c56633f9 100644 --- a/docs/manual/developer/02_building_complianceascode.md +++ b/docs/manual/developer/02_building_complianceascode.md @@ -362,7 +362,7 @@ If you want to go deeper into statistics, refer to [Profile Statistics and Utili ### Generating Sphinx Documentation Generate HTML documentation of the project that includes developer documentation, -supported Jinja Macros documentation, python modules documentation, SSG Test Suite +supported Jinja Macros documentation, python modules documentation, Automatus documentation and release tools documentation: ```bash @@ -514,7 +514,7 @@ ctest -L quick ctest -LE quick -j4 ``` -Note: CTest does not run [SSG Test Suite](https://github.com/ComplianceAsCode/content/tree/master/tests) which provides simple system of test scenarios for testing profiles and rule remediations. +Note: CTest does not run [Automatus](https://github.com/ComplianceAsCode/content/tree/master/tests) which provides simple system of test scenarios for testing profiles and rule remediations. ## Profiling the buildsystem diff --git a/linux_os/guide/system/software/integrity/software-integrity/aide/aide_scan_notification/tests/cron_weekly_configured.pass.sh b/linux_os/guide/system/software/integrity/software-integrity/aide/aide_scan_notification/tests/cron_weekly_configured.pass.sh index 3e4989f3d25..4ce6416a0c3 100644 --- a/linux_os/guide/system/software/integrity/software-integrity/aide/aide_scan_notification/tests/cron_weekly_configured.pass.sh +++ b/linux_os/guide/system/software/integrity/software-integrity/aide/aide_scan_notification/tests/cron_weekly_configured.pass.sh @@ -2,4 +2,4 @@ # packages = aide,crontabs # configured in crontab -echo '0 5 * * * root /usr/sbin/aide --check | /bin/mail -s "SSG Test Suite - AIDE Integrity Check" admin@ssgtestsuite' > /etc/cron.weekly/aidescan +echo '0 5 * * * root /usr/sbin/aide --check | /bin/mail -s "Automatus - AIDE Integrity Check" admin@automatus' > /etc/cron.weekly/aidescan diff --git a/linux_os/guide/system/software/integrity/software-integrity/aide/aide_scan_notification/tests/crontab_configured.pass.sh b/linux_os/guide/system/software/integrity/software-integrity/aide/aide_scan_notification/tests/crontab_configured.pass.sh index b1de067cc26..be408166490 100644 --- a/linux_os/guide/system/software/integrity/software-integrity/aide/aide_scan_notification/tests/crontab_configured.pass.sh +++ b/linux_os/guide/system/software/integrity/software-integrity/aide/aide_scan_notification/tests/crontab_configured.pass.sh @@ -2,4 +2,4 @@ # packages = aide,crontabs # configured in crontab -echo '0 5 * * * root /usr/sbin/aide --check | /bin/mail -s "SSG Test Suite - AIDE Integrity Check" admin@ssgtestsuite' >> /etc/crontab +echo '0 5 * * * root /usr/sbin/aide --check | /bin/mail -s "Automatus - AIDE Integrity Check" admin@automatus' >> /etc/crontab diff --git a/linux_os/guide/system/software/integrity/software-integrity/aide/aide_scan_notification/tests/var_cron_configured.pass.sh b/linux_os/guide/system/software/integrity/software-integrity/aide/aide_scan_notification/tests/var_cron_configured.pass.sh index 681ff88001e..9d16a97b8ad 100644 --- a/linux_os/guide/system/software/integrity/software-integrity/aide/aide_scan_notification/tests/var_cron_configured.pass.sh +++ b/linux_os/guide/system/software/integrity/software-integrity/aide/aide_scan_notification/tests/var_cron_configured.pass.sh @@ -2,4 +2,4 @@ # packages = aide,cronie # configured in crontab -echo '0 5 * * * root /usr/sbin/aide --check | /bin/mail -s "SSG Test Suite - AIDE Integrity Check" admin@ssgtestsuite' >> /var/spool/cron/root +echo '0 5 * * * root /usr/sbin/aide --check | /bin/mail -s "Automatus - AIDE Integrity Check" admin@automatus' >> /var/spool/cron/root diff --git a/tests/README.md b/tests/README.md index d9784701354..3e3ba2556b9 100644 --- a/tests/README.md +++ b/tests/README.md @@ -229,7 +229,7 @@ to be used to add any profile-specific information. Additionally, we have enabled test scenarios located under the templated directory, `shared/templates/.../tests`. Unlike with build-time content, `tests` does not need to be located in the template's manifest (at -`template.yml`). Instead, SSGTS will automatically parse each rule and +`template.yml`). Instead, Automatus will automatically parse each rule and prefer rule-directory-specific test scenarios over any templated scenarios that the rule uses. (E.g., if `installed.pass.sh` is present in the template `package_installed` and in the `tests/` subdirectory of the rule diff --git a/tests/install_vm.py b/tests/install_vm.py index d00a13c11a9..d65061fa0e6 100755 --- a/tests/install_vm.py +++ b/tests/install_vm.py @@ -380,11 +380,11 @@ def give_info(data): option to your ssh command and export the: export SSH_ADDITIONAL_OPTIONS='-o IdentityFile={ssh_pubkey}' -before running the SSG Test Suite.""".format(** data.__dict__)) +before running the Automatus.""".format(** data.__dict__)) if data.libvirt == "qemu:///system": print(""" -IMPORTANT: When running SSG Test Suite use: +IMPORTANT: When running Automatus use: sudo -E to make sure that your SSH key is used.""") diff --git a/tests/kickstarts/test_suite.cfg b/tests/kickstarts/test_suite.cfg index de9331d8a8e..505bf8478fe 100644 --- a/tests/kickstarts/test_suite.cfg +++ b/tests/kickstarts/test_suite.cfg @@ -108,7 +108,7 @@ openssh-server %post --log /root/post-install.log --interpreter /bin/bash -# initialize guest agent for SSG Test Suite +# initialize guest agent for Automatus systemctl enable qemu-guest-agent.service mkdir -p /root/.ssh diff --git a/tests/kickstarts/test_suite_rhel7.cfg b/tests/kickstarts/test_suite_rhel7.cfg index 5fb789a681c..44f21a23214 100644 --- a/tests/kickstarts/test_suite_rhel7.cfg +++ b/tests/kickstarts/test_suite_rhel7.cfg @@ -113,7 +113,7 @@ openssh-server %post --log /root/post-install.log --interpreter /bin/bash -# initialize guest agent for SSG Test Suite +# initialize guest agent for Automatus systemctl enable qemu-guest-agent.service mkdir -p /root/.ssh diff --git a/tests/ssg_test_suite/virt.py b/tests/ssg_test_suite/virt.py index 4ed264f623c..1e3663c9ade 100644 --- a/tests/ssg_test_suite/virt.py +++ b/tests/ssg_test_suite/virt.py @@ -22,7 +22,7 @@ class SnapshotStack(object): SNAPSHOT_BASE = ("" " {name}" " " - " Full snapshot by SSG Test Suite" + " Full snapshot by Automatus" " " "") CREATE_FLAGS = libvirt.VIR_DOMAIN_SNAPSHOT_CREATE_ATOMIC