freeipa / ipa-docker-test-runner

A development tool intended to automate running FreeIPA tests inside Docker container

FreeIPA Server

FreeIPA allows Linux administrators to centrally manage identity, authentication and access control aspects of Linux and UNIX systems by providing simple to install and use command line and web based management tools.

FreeIPA is built on top of well known Open Source components and standard protocols with a very strong focus on ease of management and automation of installation and configuration tasks.

FreeIPA can seamlessly integrate into an Active Directory environment via cross-realm Kerberos trust or user synchronization.

Benefits

FreeIPA:

• Allows all your users to access all the machines with the same credentials and security settings
• Allows users to access personal files transparently from any machine in an authenticated and secure way
• Uses an advanced grouping mechanism to restrict network access to services and files only to specific users
• Allows central management of security mechanisms like passwords, SSH Public Keys, SUDO rules, Keytabs, Access Control Rules
• Enables delegation of selected administrative tasks to other power users
• Integrates into Active Directory environments

Components

The FreeIPA project provides unified installation and management tools for the following components:

• LDAP Server - based on the 389 project
• KDC - based on MIT Kerberos implementation
• PKI based on Dogtag project
• Samba libraries for Active Directory integration
• DNS Server based on BIND and the Bind-DynDB-LDAP plugin

Project Website

Releases, announcements and other information can be found on the IPA server project page at http://www.freeipa.org/ .

Documentation

The most up-to-date documentation can be found at http://freeipa.org/page/Documentation .

Quick Start

To get started quickly, start here: http://www.freeipa.org/page/Quick_Start_Guide

For developers

• Building FreeIPA from source
  • http://www.freeipa.org/page/Build
  • See the BUILD.txt file in the source root directory

Licensing

Please see the file called COPYING.

Contacts

• If you want to be informed about new code releases, bug fixes, security fixes, general news and information about the IPA server subscribe to the freeipa-announce mailing list at https://www.redhat.com/mailman/listinfo/freeipa-interest/ .
• If you have a bug report please submit it at: https://pagure.io/freeipa/issues
• If you want to participate in actively developing IPA please subscribe to the freeipa-devel mailing list at https://lists.fedoraproject.org/archives/list/[email protected]/ or join us in IRC at irc://irc.libera.chat/freeipa

ipa-docker-test-runner's Issues

Add configuration options to ignore some of the FreeIPA tests

In a single container it makes no sense to run test_integration and test_webui suites, as these require multihost setup and are skipped by default.

Skipped tests generate a lot of cruft, however, so it would be nice to have an option to just ignore them by passing '--ignore' to ipa-run-tests

This mechanism could also be used to ignore kernel keyring tests which always fail in containerized environment

Use XDG_CONFIG_HOME for config files

It's bad style to put config files in $HOME. The correct location for config files is the directory $XDG_CONFIG_HOME/$APP_NAME/ with XDG_CONFIG_HOME=os.environ('XDG_CONFIG_HOME', os.path.expanduser('~/.config')).

Turn '--developer-mode' into a global option

--developer-mode option skips the linter steps but only for 'build' step. It would be nice, however, if we could skip lint also before running tests to save some time. The lint step can be performed concurrently as e.g. separate Travis job.

Allow to specify environment variables for the container

Implement an interface for setting 'environment' config option when creating the container. This should be doable from both the config file and CLI option as override.

Introduce a separate 'lint' subcommand

in some use cases (e.g. automated CI) it may be beneficial to have a separate 'lint' subcommand. This would essentialy run all linters. specified lint together with '--developer-mode' option should raise error about incompatible arguments/options, since the latter option implies skipping lint step.

Don't suggest sudo install

It's a bad practice to install Python packages to the system-wide site-packages directory. Please change the documentation and suggest a virtual env instead:

{{{
$ python3 -m venv venv
$ venv/bin/pip install .
$ venv/bin/ipa-docker-test-runner
}}}

Fix 'cleanup' step throwing unhandled exceptions

'cleanup' step just not throw unhandled exceptions that break the execution flow. It should ideally just log the error and continue working.

Make the individual steps (build, install rpms, etc.) configurable

There is a possibility to make the individual steps run in the container configurable from the YaML file e.g. with the help of Jinja templates to handle variable expansion.

This would allow custom setups potentially useful for developers of 389-ds or Dogtag who wish to quickly test the integration of their developer work with FreeIPA.

Allow to override config values with CLI options

ipa-docker-test-runner should accept CLI options specifying alternative git repo path, image name, and other options.

WebUI-unit tests: npm is installed using dnf instead of included in image

npm package should be included in image from the beginning instead of installing it using dnf. The reason is that it might happen that mirrors with Fedora packages are not available and test fails, which might block from pushing pullrequest. Another advantage might be that we save some time, but compared to whole time needed for running Travis jobs it is insignificant.

inform the user that command output is logged into file hen --log-file is given

When logging to file is enabled, all command output is redirected to the file and not shown in console on purpose. We should print out a short message about this behavior when ipa-docker-test-runner starts.

add dnf builddep to the build step

the build step just runs 'make' without actually checking for and installing additional BuildRequires from freeipa.spec.in. This has to be fixed. There should also be a possibility to pass additional options to dnf builddep from CLI.

Always pull the image when running

We should pull the image everytime we run ipa-docker-test-runner so that it is always updated to newest version.

Allow to specify alternate config files on the command line

a --config option should be added to override default configuration by specific overrides without enumerating CLI options.