This section only needs to be read by developers of the zhmcclient package. People that want to make a fix or develop some extension, and people that want to test the project are also considered developers for the purpose of this section.
Help us keep zhmcclient open and inclusive. Please read and follow our Code of Conduct.
The repository for zhmcclient is on GitHub:
https://github.com/zhmcclient/python-zhmcclient
The development environment is pretty easy to set up.
Besides having a supported operating system with a supported Python version (see Supported environments), it is recommended that you set up a virtual Python environment.
Then, with a virtual Python environment active, clone the Git repo of this project and prepare the development environment with make develop:
$ git clone git@github.com:zhmcclient/python-zhmcclient.git
$ cd python-zhmcclient
$ make developThis will install all prerequisites the package needs to run, as well as all prerequisites that you need for development.
Generally, this project uses Make to do things in the currently active Python environment. The command make help (or just make) displays a list of valid Make targets and a short description of what each target does.
The ReadTheDocs (RTD) site is used to publish the documentation for the zhmcclient package at http://python-zhmcclient.readthedocs.io/
This page automatically gets updated whenever the master branch of the Git repo for this package changes.
In order to build the documentation locally from the Git work directory, issue:
$ make builddocThe top-level document to open with a web browser will be build_doc/html/docs/index.html.
The zhmcclient project supports the following kinds of tests:
- unit tests against a mocked HMC, using
pytest - end2end tests against a real or mocked HMC, using
pytest - install tests (Linux and MacOS only)
To run the unit tests in the currently active Python environment, issue:
$ make testBy default, all unit tests are run. The TESTCASES environment variable can be used to limit the testcases that are run. Its value is passed to the -k option of the pytest command. For example:
$ TESTCASES=test_resource.py make test # Run only this test source file
$ TESTCASES=test_func1 make test # Run only this test function or test class
$ TESTCASES="test_func1 or test_func2" make test # Run both of these test functions or classesAdditional options for the pytest command can be specified with the TESTOPTS environment variable. For example:
$ TESTOPTS='-x' make test # Stop after first test case failure
$ TESTOPTS='--pdb' make test # Invoke debugger on each test case failureInvoke pytest --help for details on its options including the syntax of the -k option, or see pytest options.
To run the unit tests and some more commands that verify the project is in good shape in all supported Python environments, use Tox. The positional arguments of the tox command are passed to pytest using its -k option. For example:
$ tox # Run all tests on all supported Python versions
$ tox -e py27 # Run all tests on Python 2.7
$ tox -e py27 test_resource.py # Run only this test source file on Python 2.7
$ tox -e py27 TestInit # Run only this test class on Python 2.7
$ tox -e py27 TestInit or TestSet # pytest -k expressions are possiblePrepare an HMC inventory file that defines real and/or mocked HMCs the tests should be run against, and an HMC vault file with credentials for the real HMCs.
There are examples for these files, that describe their format in the comment header:
To run the end2end tests in the currently active Python environment, issue:
$ make end2endBy default, the HMC inventory file named .zhmc_inventory.yaml in the home directory of the current user is used. A different path name can be specified with the TESTINVENTORY environment variable.
By default, the HMC vault file named .zhmc_vault.yaml in the home directory of the current user is used. A different path name can be specified with the TESTVAULT environment variable.
By default, the tests are run against the group name or HMC nickname default defined in the HMC inventory file. A different group name or HMC nickname can be specified with the TESTHMC environment variable.
Examples:
Run against group or HMC nickname 'default' using the specified HMC inventory and vault files:
$ TESTINVENTORY=`./hmc_inventory.yaml` TESTVAULT=`./hmc_vault.yaml` make end2endRun against group or HMC nickname 'HMC1' using the default HMC inventory and vault files:
$ TESTHMC=`HMC1` make end2end
TODO: At this point, the `setup_logging()` function that enables the logging described in this section is not used in the end2end tests
The end2end tests have the ability to log the API calls to the zhmcclient library and the interactions with the (real or mocked) HMC.
By default, logging is set up such that the zhmcclient library logs messages with a log level of "warning" or higher, to stderr.
The log level and the components to be logged can be set using the ZHMC_LOG environment variable:
$ export ZHMC_LOG=COMP=LEVEL[,COMP=LEVEL[,...]]Where:
COMPis one of:all,api,hmc.LEVELis one of:error,warning,info,debug.
For example, to enable logging of the zhmcclient API calls and the interactions with the HMC, use:
$ export ZHMC_LOG=api=debug,hmc=debugor, shorter:
$ export ZHMC_LOG=all=debugThe HMC inventory file specifies HMCs and/or groups of HMCs to be used for any code that uses the zhmcclient.testutils module, such as the end2end tests, the example scripts, other zhmcclient projects, or even projects by users of the zhmcclient library.
The HMCs and HMC groups defined in the HMC inventory file have nicknames and the nickname to be used for end2end tests and the example scripts can be specified using the TESTHMC environment variable, for example:
$ TESTHMC=HMC1 make end2end # run end2end tests against nickname "HMC1"
$ TESTHMC=HMC1 examples/list_cpcs.py # run this example script against nickname "HMC1"If no nickname is specified using the TESTHMC environment variable, the nickname "default" is used, for example:
$ make end2end # run end2end tests against nickname "default""
$ examples/list_cpcs.py # run this example script against nickname "default""By default, the HMC inventory file ~/.zhmc_inventory.yaml is used. A different path name can be specified with the TESTINVENTORY environment variable.
The following describes the structure of the HMC inventory file:
all: # Nickname of the top-level HMC group; must be 'all'.
hosts: # Definition of all HMCs, each with an item as follows:
<hmc_nick>: # Nickname of an HMC; may be a DNS hostname, IP address,
# or arbitrary string.
description: <string> # Optional: One line description of the HMC.
contact: <string> # Optional: Informal reference to a contact for the HMC.
access_via: <string> # Optional: Reminder on network setup needed for access.
ansible_host: <host> # If real HMC: DNS hostname or IP address of HMC, if
# arbitrary string was used as HMC nickname.
mock_file: <path_name> # If mocked HMC: Relative path name of HMC mock file.
cpcs: # CPCs to test against. Can be a subset or all CPCs
# managed by the HMC.
<cpc_name>: # CPC name.
dpm_enabled: <bool> # Whether the CPC is in DPM mode (true) or classic mode
# (false). This is used to include the CPC in pytest
# fixtures that select CPCs based on their mode.
<prop_name>: <prop_value> # Optional: Additional expected CPC properties, for
# use by test functions.
<var_name>: <var_value> # Optional: Additional variables for this HMC, for use
# by test functions.
vars: # Optional: Additional variables for all HMCs, for use
# by test functions.
<var_name>: <var_value>
children: # Optional: HMC groups.
<group_nick>: # Nickname of this HMC group.
hosts: # The HMCs in this group.
<hmc_nick>: # Reference to an HMC in this group via its nickname.
... # Optional: Additional variables to override the ones
# inherited from the parent HMC definition. Not
# normally needed.
vars: # Optional: Additional variables for the HMCs in this
# group.
<var_name>: <var_value>
children: # Optional: Grand child groups. Only ever needed when
... # using variable inheritance for some reason.
# Can be further nested.Here is the example HMC inventory file examples/example_hmc_inventory.yaml:
../examples/example_hmc_inventory.yaml
In that example HMC inventory file, the following nicknames of single HMCs are defined:
- HMC1 - The HMC at 10.11.12.13.
- MOCKED_Z16_CLASSIC - The mocked HMC defined in mock file examples/example_mocked_z16_classic.yaml.
- MOCKED_Z16_DPM - The mocked HMC defined in mock file examples/example_mocked_z16_dpm.yaml.
The following nicknames of HMC groups are defined:
- all - All HMCs, i.e. HMC1, MOCKED_Z16_CLASSIC, and MOCKED_Z16_DPM.
- default - The HMCs with nicknames MOCKED_Z16_CLASSIC and MOCKED_Z16_DPM.
- dev - The HMC with nickname HMC1.
The tests that use CPCs or resources within CPCs will be run against only the subset of CPCs that are defined in the cpcs variables of the HMC entries. In that example HMC inventory file, those are:
- For HMC1: Only the CPCs XYZ1 and XYZ2.
- For MOCKED_Z16_CLASSIC: Only the CPC CPC1.
- For MOCKED_Z16_DPM: Only the CPC CPC1.
Any variables defined for the HMCs are available to the test functions via an ~zhmcclient.testutils.HMCDefinition object. See pytest fixture ~zhmcclient.testutils.hmc_session for details.
The format of HMC inventory files is compatible with the format of Ansible inventory files in YAML format, with the following extensions:
- Certain variables in the definition of HMC hosts have a defined meaning. See the format description above for details.
and the following limitations:
- DNS host names or IP addresses with ranges (e.g.
myhost[0:9].xyz.com) are not supported.
For more details on the format of Ansible inventory files, see Ansible: How to build your inventory.
The HMC vault file specifies credentials for real HMCs to be used for any code that uses the zhmcclient.testutils module, such as the end2end tests, the example scripts, other zhmcclient projects, or even projects by users of the zhmcclient library.
It is required to have the HMC credentials in the HMC vault file; they cannot be specified in the HMC inventory file.
By default, the HMC vault file ~/.zhmc_vault.yaml is used. A different path name can be specified with the TESTVAULT environment variable.
The data items for HMCs in the HMC vault file are looked up using the HMC names from the HMC inventory file, so they must match.
The following describes the structure of the HMC vault file:
hmc_auth:
<hmc_nick>: # Nickname of an HMC defined in the inventory file
userid: <string> # HMC userid
password: <string> # HMC password
verify: <bool> # Indicates whether the server certificate returned
# by the HMC should be validated.
ca_certs: <ca_certs> # Used for verify_cert init parm of zhmcclient.Session
<var_name>: <var_value> # Any other variables are allowed but will be ignoredFor details about <ca_certs>, see the description of the verify_cert init parameter of the zhmcclient.Session class.
Here is the example HMC vault file examples/example_hmc_vault.yaml:
../examples/example_hmc_vault.yaml
The format of HMC vault files is compatible with the format of Ansible vault files in YAML format, with the following limitations:
- In the current release, HMC vault files cannot be encrypted. To mitigate that, set restrictive file permissions on the HMC vault files.
The zhmcclient.testutils module provides support for developing tests that run against real HMCs or mocked HMCs defined with the mock support.
These HMCs are defined in an HMC inventory file, and their credentials are defined in an HMC vault file.
This module defines pytest fixtures for use by the test functions and encapsulates the access to the HMC inventory and vault files.
Pytest fixtures are used as parameters of test functions. When used, they are specified just with their name. Pytest resolves the parameters of test functions to its known fixtures, based upon the parameter name.
zhmcclient.testutils.hmc_definition
zhmcclient.testutils.hmc_session
zhmcclient.testutils.all_cpcs
zhmcclient.testutils.dpm_mode_cpcs
zhmcclient.testutils.classic_mode_cpcs
zhmcclient.testutils.hmc_definitions
zhmcclient.testutils.print_hmc_definitions
zhmcclient.testutils.HMCDefinitions
zhmcclient.testutils.HMCDefinition
zhmcclient.testutils.HMCInventoryFile
zhmcclient.testutils.HMCVaultFile
zhmcclient.testutils.HMCInventoryFileError
zhmcclient.testutils.HMCVaultFileError
zhmcclient.testutils.HMCNoVaultError
zhmcclient.testutils.HMCNotFound
Third party contributions to this project are welcome!
In order to contribute, create a Git pull request, considering this:
- Test is required.
- Each commit should only contain one "logical" change.
- A "logical" change should be put into one commit, and not split over multiple commits.
- Large new features should be split into stages.
- The commit message should not only summarize what you have done, but explain why the change is useful.
- The commit message must follow the format explained below.
What comprises a "logical" change is subject to sound judgement. Sometimes, it makes sense to produce a set of commits for a feature (even if not large). For example, a first commit may introduce a (presumably) compatible API change without exploitation of that feature. With only this commit applied, it should be demonstrable that everything is still working as before. The next commit may be the exploitation of the feature in other components.
For further discussion of good and bad practices regarding commits, see:
A commit message must start with a short summary line, followed by a blank line.
Optionally, the summary line may start with an identifier that helps identifying the type of change or the component that is affected, followed by a colon.
It can include a more detailed description after the summary line. This is where you explain why the change was done, and summarize what was done.
It must end with the DCO (Developer Certificate of Origin) sign-off line in the format shown in the example below, using your name and a valid email address of yours. The DCO sign-off line certifies that you followed the rules stated in DCO 1.1. In short, you certify that you wrote the patch or otherwise have the right to pass it on as an open-source patch.
We use GitCop during creation of a pull request to check whether the commit messages in the pull request comply to this format. If the commit messages do not comply, GitCop will add a comment to the pull request with a description of what was wrong.
Example commit message:
cookies: Add support for delivering cookies
Cookies are important for many people. This change adds a pluggable API for
delivering cookies to the user, and provides a default implementation.
Signed-off-by: Random J Developer <random@developer.org>Use git commit --amend to edit the commit message, if you need to.
Use the --signoff (-s) option of git commit to append a sign-off line to the commit message with your name and email as known by Git.
If you like filling out the commit message in an editor instead of using the -m option of git commit, you can automate the presence of the sign-off line by using a commit template file:
Create a file outside of the repo (say,
~/.git-signoff.template) that contains, for example:<one-line subject> <detailed description> Signed-off-by: Random J Developer <random@developer.org>Configure Git to use that file as a commit template for your repo:
git config commit.template ~/.git-signoff.template
This section shows the steps for releasing a version to PyPI.
It covers all variants of versions that can be released:
- Releasing a new major version (Mnew.0.0) based on the master branch
- Releasing a new minor version (M.Nnew.0) based on the master branch
- Releasing a new update version (M.N.Unew) based on the stable branch of its minor version
This description assumes that you are authorized to push to the remote repo at https://github.com/zhmcclient/python-zhmcclient and that the remote repo has the remote name origin in your local clone.
Any commands in the following steps are executed in the main directory of your local clone of the python-zhmcclient Git repo.
On GitHub, verify open items in milestone
M.N.U.Verify that milestone
M.N.Uhas no open issues or PRs anymore. If there are open PRs or open issues, make a decision for each of those whether or not it should go into versionM.N.Uyou are about to release.If there are open issues or PRs that should go into this version, abandon the release process.
If none of the open issues or PRs should go into this version, change their milestones to a future version, and proceed with the release process. You may need to create the milestone for the future version.
Set shell variables for the version that is being released and the branch it is based on:
MNU- Full version M.N.U that is being releasedMN- Major and minor version M.N of that full versionBRANCH- Name of the branch the version that is being released is based on
When releasing a new major version (e.g.
1.0.0) based on the master branch:MNU=1.0.0 MN=1.0 BRANCH=master
When releasing a new minor version (e.g.
0.9.0) based on the master branch:MNU=0.9.0 MN=0.9 BRANCH=master
When releasing a new update version (e.g.
0.8.1) based on the stable branch of its minor version:MNU=0.8.1 MN=0.8 BRANCH=stable_${MN}Create a topic branch for the version that is being released:
git checkout ${BRANCH} git pull git checkout -b release_${MNU}
Edit the version file:
vi zhmcclient/_version.py
and set the
__version__variable to the version that is being released:__version__ = 'M.N.U'
Edit the change log:
vi docs/changes.rst
and make the following changes in the section of the version that is being released:
- Finalize the version.
- Change the release date to today's date.
- Make sure that all changes are described.
- Make sure the items shown in the change log are relevant for and understandable by users.
- In the "Known issues" list item, remove the link to the issue tracker and add text for any known issues you want users to know about.
- Remove all empty list items.
Commit your changes and push the topic branch to the remote repo:
git commit -asm "Release ${MNU}" git push --set-upstream origin release_${MNU}
On GitHub, create a Pull Request for branch
release_M.N.U.Important: When creating Pull Requests, GitHub by default targets the
masterbranch. When releasing based on a stable branch, you need to change the target branch of the Pull Request tostable_M.N.Set the milestone of that PR to version
M.N.U.This PR should normally be set to be reviewed by at least one of the maintainers.
The PR creation will cause the "test" workflow to run. That workflow runs tests for all defined environments, since it discovers by the branch name that this is a PR for a release.
On GitHub, once the checks for that Pull Request have succeeded, merge the Pull Request (no review is needed). This automatically deletes the branch on GitHub.
If the PR did not succeed, fix the issues.
On GitHub, close milestone
M.N.U.Verify that the milestone has no open items anymore. If it does have open items, investigate why and fix. If the milestone does not have open items anymore, close the milestone.
Publish the package
git checkout ${BRANCH} git pull git branch -D release_${MNU} git branch -D -r origin/release_${MNU} git tag -f ${MNU} git push -f --tags
Pushing the new tag will cause the "publish" workflow to run. That workflow builds the package, publishes it on PyPI, creates a release for it on Github, and finally creates a new stable branch on Github if the master branch was released.
Verify the publishing
Wait for the "publish" workflow for the new release to have completed: https://github.com/zhmcclient/python-zhmcclient/actions/workflows/publish.yml
Then, perform the following verifications:
- Verify that the new version is available on PyPI at https://pypi.python.org/pypi/zhmcclient/
- Verify that the new version has a release on Github at https://github.com/zhmcclient/python-zhmcclient/releases
Verify that the new version has documentation on ReadTheDocs at https://python-zhmcclient.readthedocs.io/en/latest/changes.html
The new version
M.N.Ushould be automatically active on ReadTheDocs, causing the documentation for the new version to be automatically built and published.If you cannot see the new version after some minutes, log in to https://readthedocs.org/projects/python-zhmcclient/versions/ and activate the new version.
This section shows the steps for starting development of a new version.
This section covers all variants of new versions:
- Starting a new major version (Mnew.0.0) based on the master branch
- Starting a new minor version (M.Nnew.0) based on the master branch
- Starting a new update version (M.N.Unew) based on the stable branch of its minor version
This description assumes that you are authorized to push to the remote repo at https://github.com/zhmcclient/python-zhmcclient and that the remote repo has the remote name origin in your local clone.
Any commands in the following steps are executed in the main directory of your local clone of the python-zhmcclient Git repo.
Set shell variables for the version that is being started and the branch it is based on:
MNU- Full version M.N.U that is being startedMN- Major and minor version M.N of that full versionBRANCH- Name of the branch the version that is being started is based on
When starting a new major version (e.g.
1.0.0) based on the master branch:MNU=1.0.0 MN=1.0 BRANCH=master
When starting a new minor version (e.g.
0.9.0) based on the master branch:MNU=0.9.0 MN=0.9 BRANCH=master
When starting a new minor version (e.g.
0.8.1) based on the stable branch of its minor version:MNU=0.8.1 MN=0.8 BRANCH=stable_${MN}Create a topic branch for the version that is being started:
git fetch origin git checkout ${BRANCH} git pull git checkout -b start_${MNU}
Edit the version file:
vi zhmcclient/_version.py
and update the version to a draft version of the version that is being started:
__version__ = 'M.N.U.dev1'
Edit the change log:
vi docs/changes.rst
and insert the following section before the top-most section:
Version M.N.U.dev1 ^^^^^^^^^^^^^^^^^^ This version contains all fixes up to version M.N-1.x. Released: not yet **Incompatible changes:** **Deprecations:** **Bug fixes:** **Enhancements:** **Cleanup:** **Known issues:** * See `list of open issues`_. .. _`list of open issues`: https://github.com/zhmcclient/python-zhmcclient/issues
Commit your changes and push them to the remote repo:
git commit -asm "Start ${MNU}" git push --set-upstream origin start_${MNU}
On GitHub, create a milestone for the new version
M.N.U.You can create a milestone in GitHub via Issues -> Milestones -> New Milestone.
On GitHub, create a Pull Request for branch
start_M.N.U.Important: When creating Pull Requests, GitHub by default targets the
masterbranch. When starting a version based on a stable branch, you need to change the target branch of the Pull Request tostable_M.N.No review is needed for this PR.
Set the milestone of that PR to the new version
M.N.U.On GitHub, go through all open issues and pull requests that still have milestones for previous releases set, and either set them to the new milestone, or to have no milestone.
Note that when the release process has been performed as described, there should not be any such issues or pull requests anymore. So this step here is just an additional safeguard.
- On GitHub, once the checks for the Pull Request for branch
start_M.N.Uhave succeeded, merge the Pull Request (no review is needed). This automatically deletes the branch on GitHub. Update and clean up the local repo:
git checkout ${BRANCH} git pull git branch -D start_${MNU} git branch -D -r origin/start_${MNU}