Configure and run an rspec lab to run your tests
These projects are an effort by the Openstack infrastructure team to provide continuous integration testing and code review for OpenStack and OpenStack community projects as part of the core software.
Each project is a thorough attempt to make Puppet capable of managing the entirety of specific parts, like, nova, oslo, neutron, etc.
Each time you contribute to these projects you need to ensure yourself that your features works and that your changes fit well.
Openstack puppet based projects’ tests are designed by using the rspec-puppet framework.
rspec-puppet need several dependencies on your environment or your
laptop, so it can be difficult to setup a puppet environment for
testing purpose, especially when you are not a regular contributor
to these puppet projects.
In this blog post we will show how to test your changes in a merely manner by using the rspec-container.
rspec-container project provide to you a preconfigured environment via
a pre designed container who will avoid you to spend time to setup this and
to be more focused on your tests and features.
To run this recipe you need to install the following tools:
Here we start by setup our rspec lab.
First, clone the
$ git clone firstname.lastname@example.org/cjeanner/rspec-container
rspec-container will mount some default path and dotfiles:
These mounts are defined in the docker-compose file.
work directory normally contains your repositories and projects.
If like me you doesn’t have the
work directory on your laptop and you don’t
want to edit the docker compose file at each run, you can create a symlink who
narrow your own development directory.
By example in my case it looks like to:
$ ln -s ~/dev ~/work
Then now you can start your lab and enter on:
$ docker-compose up & Creating rspec-container_rspec_1 ... done Attaching to rspec-container_rspec_1 $ docker exec -it rspec-container_rspec_1 /bin/bash
As I’m an openstack oslo core developer, I will use the puppet-oslo project as an example here.
Consider that we are in connected to our lab, and consider that we have
already cloned the
puppet-oslo project under
~/work, so our environment
$ ls -la ~/work drwxrwxr-x. 12 herve herve 4096 Nov 25 10:36 puppet-oslo
Then go to your project directory (or clone your own if needed):
$ cd work/puppet-oslo $ bundle install Fetching gem metadata from https://rubygems.org/......... Fetching version metadata from https://rubygems.org/... Fetching dependency metadata from https://rubygems.org/.. Fetching https://opendev.org/openstack/puppet-openstack_spec_helper Installing rake 13.0.1 Installing CFPropertyList 2.3.6 Installing concurrent-ruby 1.1.5 Installing minitest 5.13.0 Installing thread_safe 0.3.6 ... Using puppet-openstack_spec_helper 16.0.0 from https://opendev.org/openstack/puppet-openstack_spec_helper (at master@d38ed71) Bundle complete! 3 Gemfile dependencies, 139 gems now installed. Use `bundle show [gemname]` to see where a bundled gem is installed. $ # be sure to add binaries to your env $ export PATH=$PATH:$HOME/bin:/var/lib/gems/1.8/bin $ bundle exec rake spec # depend on your project but sometime `spec` will be named `rspec` rm -rf openstack/puppet-openstack-integration git clone https://opendev.org/openstack/puppet-openstack-integration openstack/puppet-openstack-integration Cloning into 'openstack/puppet-openstack-integration'... remote: Enumerating objects: 7326, done. remote: Counting objects: 100% (7326/7326), done. remote: Compressing objects: 100% (3291/3291), done. remote: Total 7326 (delta 5063), reused 6193 (delta 4005) Receiving objects: 100% (7326/7326), 1.27 MiB | 415.00 KiB/s, done. Resolving deltas: 100% (5063/5063), done. env PUPPETFILE_DIR=/home/hberaud/work/redhat/upstream/openstack/puppet-oslo/spec/fixtures/modules ZUUL_BRANCH= bash openstack/puppet-openstack-integration/install_modules_unit.sh ... Finished in 1 minute 51.47 seconds (files took 2 minutes 4.5 seconds to load) 1050 examples, 0 failures
If everything work fine you will see a message who looks like to something like:
Finished in 1 minute 51.47 seconds (files took 2 minutes 4.5 seconds to load) 1050 examples, 0 failures
Now that your environment works and can spend time to develop your tests and do some back and forth with your patches.