Skip to content

Latest commit

 

History

History
86 lines (66 loc) · 2.34 KB

DEVELOPMENT.md

File metadata and controls

86 lines (66 loc) · 2.34 KB
Raw

Prepare development environment

Create python venv and clone code.

mkdir -p ansible_collections/scale_computing/
cd ansible_collections/scale_computing/

python3.10 -m venv .venv
source .venv/bin/activate
pip install --upgrade pip
# ansible-core==2.13.1 was used during development and testing,
# but version from 2.9.x up should work
pip install ansible-core

git clone ssh://[email protected]:13022/scale-ansible-collection/scale-computing-hc3-ansible-collection.git hypercore
cd hypercore

# Install community.general collection, since we like to have stdout_callback=community.general.yaml in ansible.cfg
ansible-galaxy collection install community.general
# Optional, if you want to run "ansible-test --venv ..."
# pip install -r test.requirements -r sanity.requirements

The collection needs to know how to assess the destination HyperCore cluster. Normally this is to playbooks via environ variables. To be able to run example playbooks execute in shell:

export SC_HOST=https://1.2.3.4
export SC_USERNAME=admin
export SC_PASSWORD=admin_pass

Integration tests configuration

For integration tests we need to configure access to test cluster. Copy template and edit it:

cp tests/integration/integration_config.yml.template tests/integration/integration_config.yml
nano tests/integration/integration_config.yml

# sample content
cat tests/integration/integration_config.yml
sc_host: https://1.2.3.4
sc_username: admin
sc_password: admin_pass

Development

Included Makefile contains shortcuts for common development tasks, running tests, linter, code formatting, source directory cleanup etc. To list all available commands, run just make, and you will get something like:

(.venv) [me@mypc hypercore]$ make
Available targets:
clean:  ## Remove all auto-generated files
format:  ## Format python code with black
integration:  ## Run integration tests
sanity:  ## Run sanity tests
units:  ## Run unit tests

If you want to run tests with a single python version (e.g. not with whole test matrix), use:

ansible-test sanity --venv
ansible-test units --venv
ansible-test integration --venv

Build collection.

ansible-galaxy collection build

Run sample playbook. Sample ansible.cfg is there to ensure collection does not need to be installed.

ansible-playbook -i localhost, examples/iso_info.yml -v