Added install-ansible and install-pipx modules #158
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,3 +14,5 @@ node_modules/ | |
| build/ | ||
| dist/ | ||
| .cache | ||
| tests/deploy/cfbs.json | ||
| tests/deploy/out | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| .PHONY: check lint format all clean tools | ||
|
|
||
| all: tools clean lint format check | ||
|
|
||
| tools: | ||
| sudo pipx install --global flake8 pyright black pyflakes pytest cfbs cfengine | ||
| echo "deploy test requires cf-agent installed..." | ||
| command -v cf-agent | ||
|
|
||
| clean: | ||
| rm -rf tests/deploy/out | ||
|
|
||
| lint: clean tools | ||
| cfbs status | ||
| cfbs validate | ||
| cfbs --check pretty ./cfbs.json | ||
| ./ci/linting.sh | ||
| cfengine lint --strict no ./ | ||
|
|
||
| format: lint | ||
| cfengine format --check | ||
|
|
||
| check: format | ||
| pytest promise-types/ -v | ||
| bash tests/deploy/test.sh |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| # Steps here based on this guide: https://docs.ansible.com/projects/ansible/latest/installation_guide/intro_installation.html | ||
| # | ||
| # host specific data supported, in the data bundle context | ||
| # | ||
| # ansible_installed: class, if defined, installed ansible | ||
|
Member
There was a problem hiding this comment. below you are keying off of |
||
| # ansible_minimal_install: class, if defined, minimal install aka ansible-core | ||
| # ansible_full_install: class, if defined, full install. This is the default if neither minimal or full classes are defined. | ||
|
Comment on lines
+6
to
+7
Member
There was a problem hiding this comment. same, I would call out the namespace explicitly here. |
||
| bundle agent install_ansible | ||
| { | ||
| methods: | ||
| linux.data:install_ansible:: | ||
| "install_ansible_main"; | ||
|
|
||
| reports: | ||
| windows:: | ||
| "Use WSL to install Ansible on Windows. See https://blog.rolpdog.com/2020/03/why-no-ansible-controller-for-windows.html"; | ||
|
|
||
| !linux:: | ||
| "Installing Ansible on a non-Linux host is not currently supported"; | ||
|
Comment on lines
+15
to
+19
Member
There was a problem hiding this comment. Maybe swap the order so that the reports come out saying installing ansible on non liux isnt supported and then emits the instruction for installing on windows. |
||
| } | ||
|
|
||
| bundle agent install_ansible_main | ||
| { | ||
| classes: | ||
| "ansible_installed" | ||
| expression => returnszero("command -v ansible >/dev/null", "useshell"); | ||
|
Member
There was a problem hiding this comment. Humm, my instinct would be to use something like isgreaterthan(length(packagematching())) I guess you should guard this classes promise with Woudlnt it be nice to have a "default context" for a file or bundle where you could set the default context here to linux? |
||
|
|
||
| vars: | ||
| "install_ansible_command" | ||
| string => "${base_command}==${data:install_ansible.version}", | ||
| if => isvariable("data:install_ansible.version"); | ||
|
|
||
| "install_ansible_command" | ||
| string => "${base_command}", | ||
| if => not(isvariable("data:install_ansible.version")); | ||
|
|
||
| data:ansible_minimal_install:: | ||
| "base_command" string => "pipx install --global ansible-core"; | ||
|
|
||
| data:ansible_full_install|(!data:ansible_full_install.!data:ansible_minimal_install):: | ||
| "base_command" string => "pipx install --global --include-deps ansible"; | ||
|
Comment on lines
+29
to
+41
Member
There was a problem hiding this comment. ifelse() might read more nicely. |
||
|
|
||
| methods: | ||
| "install_pipx_main" classes => if_ok("pipx_installed"); | ||
|
Member
There was a problem hiding this comment. I am not a fan of the if_ok classes body it sort of papers over repaired saying it's totally ok, but sometimes you can repair and still not be ok (semantic nitpic). this one doesn't need guarding because it wont trigger in pre-eval. |
||
|
|
||
| commands: | ||
| pipx_installed.!ansible_installed:: | ||
| "${install_ansible_command}" | ||
| contain => in_shell_umask(022), | ||
| comment => "The default umask of 077 would create /opt/pipx/venvs/ansible which is inaccessible to everyone but root, so use 022 instead."; | ||
|
Comment on lines
+47
to
+50
Member
There was a problem hiding this comment. I guess the old pip package methods don't work well for this? |
||
|
|
||
| reports: | ||
| ansible_installed:: | ||
| "ansible_installed"; | ||
|
Comment on lines
+52
to
+54
Member
There was a problem hiding this comment. I would delete this report before shipping. |
||
| } | ||
|
|
||
| body contain in_shell_umask(umask) | ||
| { | ||
| useshell => "true"; | ||
| umask => "${umask}"; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| bundle agent install_pipx | ||
| { | ||
| methods: | ||
| linux.data:install_pipx:: | ||
| "install_pipx_main"; | ||
|
|
||
| reports: | ||
| windows:: | ||
| "Use WSL to install software"; | ||
|
|
||
| !linux:: | ||
| "Installing Ansible on a non-Linux host is not currently supported"; | ||
|
Comment on lines
+8
to
+12
Member
There was a problem hiding this comment. Maybe reverse the order of reports so it says not supported and then tells how to install on windows? |
||
| } | ||
|
|
||
| bundle agent install_pipx_main | ||
| { | ||
| classes: | ||
| "pipx_installed" | ||
| expression => returnszero("command -v pipx >/dev/null", "useshell"); | ||
|
Comment on lines
+18
to
+19
Member
There was a problem hiding this comment. Guard this on linux:: to avoid execution on non-linux cause pre-eval |
||
|
|
||
| packages: | ||
| "pipx" classes => if_ok("pipx_package_ok"); | ||
|
|
||
| files: | ||
| pipx_installed|pipx_package_ok:: | ||
| "/opt/pipx" | ||
| perms => mog("755", "root", "root"), | ||
| comment => "/opt/pipx in some cases will be 700 which prevents non-root users from running installed commands."; | ||
|
|
||
| "/opt/pipx/venvs" | ||
| perms => mog("755", "root", "root"), | ||
| depth_search => recurse_with_base("1"), | ||
| comment => "/opt/pipx/venvs in some cases will be 700 which prevents non-root users from running installed commands."; | ||
|
Member
There was a problem hiding this comment. Curious about those cases. Is that specific platform? |
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| #!/usr/bin/env bash | ||
| # assumes deploy.sh has already run adjacent to this file | ||
|
|
||
| set -ex | ||
| sudo cf-agent -KI > log | ||
| if grep 'error:' log; then | ||
| grep 'error:' log | ||
| exit 1 | ||
| fi |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| #!/usr/bin/env bash | ||
| # assumes deploy.sh has already run adjacent to this file | ||
|
|
||
| set -ex | ||
|
|
||
| sudo pipx uninstall --global ansible || true | ||
| sudo pipx uninstall --global ansible-core || true | ||
|
|
||
| sudo cf-agent -Kd -Ddata:install_ansible -Ddata:ansible_full_install --bundle install_ansible > log | ||
| if grep 'error:' log; then | ||
| grep 'error:' log | ||
| exit 1 | ||
| fi | ||
|
|
||
| ansible --version | ||
| echo "expect that ansible-core is not installed via pipx list" | ||
| if ( sudo pipx list --global --short | grep ansible-core ); then | ||
| echo "expected only ansible to be installed, but found ansible-core" | ||
| exit 1 | ||
| fi |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| #!/usr/bin/env bash | ||
| set -ex | ||
|
|
||
| sudo pipx uninstall --global ansible || true | ||
| sudo pipx uninstall --global ansible-core || true | ||
|
|
||
| sudo cf-agent -Kd -Ddata:install_ansible -Ddata:ansible_minimal_install --bundle install_ansible > log | ||
| if grep 'error:' log; then | ||
| grep 'error:' log | ||
| exit 1 | ||
| fi | ||
|
|
||
| ansible --version | ||
| if ! ( sudo pipx list --global --short | grep ansible-core ); then | ||
| echo "expected ansible-core to be installed but did not find that in pipx list output" | ||
| fi |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| #!/usr/bin/env bash | ||
| set -ex | ||
|
|
||
| sudo pipx uninstall --global ansible || true | ||
| sudo pipx uninstall --global ansible-core || true | ||
|
|
||
| function cleanup | ||
| { | ||
| sudo rm -f /var/cfengine/data/host_specific.json || true # to make sure any version data is removed for other tests other runs | ||
| } | ||
|
|
||
| trap cleanup EXIT | ||
|
|
||
| good_version="2.21.3" | ||
|
|
||
| sudo mkdir -p /var/cfengine/data | ||
| cat <<EOF | sudo tee /var/cfengine/data/host_specific.json | ||
| { | ||
| "vars": { | ||
| "data:install_ansible.version": "$good_version" | ||
| } | ||
| } | ||
| EOF | ||
|
|
||
| sudo cf-agent -Kd -Ddata:install_ansible -Ddata:ansible_minimal_install --bundle install_ansible > log | ||
|
|
||
| if grep 'error:' log; then | ||
| grep 'error:' log | ||
| exit 1 | ||
| fi | ||
|
|
||
| ansible --version | grep "${good_version}" | ||
|
|
||
| sudo pipx uninstall --global ansible || true | ||
| sudo pipx uninstall --global ansible-core || true | ||
|
|
||
| bad_version="x.y.z" | ||
| cat <<EOF | sudo tee /var/cfengine/data/host_specific.json | ||
| { | ||
| "vars": { | ||
| "data:install_ansible.version": "$bad_version" | ||
| } | ||
| } | ||
| EOF | ||
| echo "Evaluating install_ansible bundle expecting an error due to bad version value" | ||
| sudo cf-agent -Kd -Ddata:install_ansible -Ddata:ansible_minimal_install --bundle install_ansible > log | ||
|
|
||
| if grep 'error:' log; then | ||
| echo "Expected error found due to bad version value. Test passes." | ||
| grep 'error:' log | ||
| exit 0 | ||
| fi | ||
|
|
||
| echo "Expected errors when installing ansible with bad version" | ||
| exit 1 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| #!/usr/bin/env bash | ||
| set -ex | ||
|
|
||
| echo "WARNING/TODO: This test, $0, requires all changes to be pushed up to a branch in order to test the latest. This could be improved if cfbs add could work with the modules repo and a cfbs.json file. See ENT-14421" | ||
| if [ -n "$GITHUB_HEAD_REF" ]; then | ||
| # github case | ||
| BRANCH="$GITHUB_HEAD_REF" | ||
| else | ||
| # local case | ||
| BRANCH=$(git rev-parse --abbrev-ref HEAD) | ||
| fi | ||
|
|
||
| # workaround, if git@ url then we get Error: Cannot specify more than one version of the same module | ||
| # so transform the remote url | ||
| REPO=$(git remote get-url origin | \ | ||
| sed -e 's,git@,https://,' \ | ||
| -e 's,com:,com/,' \ | ||
| ) | ||
|
|
||
| if [ -n "$GITHUB_HEAD_REF" ]; then | ||
| REPO="$(echo "$REPO" | sed -e "s,cfengine,$GITHUB_TRIGGERING_ACTOR,")" | ||
| fi | ||
|
|
||
| thisdir="$(dirname "$0")" | ||
| cd "$thisdir" | ||
| [ -d .git ] && rm -rf .git | ||
| [ -f cfbs.json ] && rm cfbs.json | ||
| cfbs --version | ||
| cfbs init --non-interactive | ||
| cfbs --non-interactive add "$REPO@$BRANCH" | ||
| cfbs build | ||
| sudo cfbs install | ||
| sudo cf-agent -IB 127.0.0.1 > log | ||
|
|
||
| if grep 'error:' log; then | ||
| grep 'error:' log | ||
| exit 1 | ||
| fi | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| #!/usr/bin/env bash | ||
| set -ex | ||
| thisdir="$(dirname "$0")" | ||
| bash "$thisdir"/deploy.sh | ||
| if ls "$thisdir"/0*.sh >/dev/null; then | ||
| for test in "$thisdir"/0*.sh; do | ||
| bash -ex "$test" | ||
| done | ||
| fi |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is 1 hour?