Skip to content

Commit

Permalink
Merge pull request ComplianceAsCode#11404 from jan-cerny/finish_rename
Browse files Browse the repository at this point in the history
Finish rename to Automatus
  • Loading branch information
marcusburghardt authored Dec 21, 2023
2 parents 41ad190 + 4ca38c1 commit 3e0377f
Show file tree
Hide file tree
Showing 11 changed files with 15 additions and 15 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/manual/developer/02_building_complianceascode.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions tests/install_vm.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.""")

Expand Down
2 changes: 1 addition & 1 deletion tests/kickstarts/test_suite.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion tests/kickstarts/test_suite_rhel7.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion tests/ssg_test_suite/virt.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class SnapshotStack(object):
SNAPSHOT_BASE = ("<domainsnapshot>"
" <name>{name}</name>"
" <description>"
" Full snapshot by SSG Test Suite"
" Full snapshot by Automatus"
" </description>"
"</domainsnapshot>")
CREATE_FLAGS = libvirt.VIR_DOMAIN_SNAPSHOT_CREATE_ATOMIC
Expand Down

0 comments on commit 3e0377f

Please sign in to comment.