From e9aac0c6099c712d8702ab00ea7d55592a6a0361 Mon Sep 17 00:00:00 2001 From: Takashi Kajinami Date: Fri, 15 Mar 2024 18:24:11 +0900 Subject: [PATCH] Drop description about beaker We replaced beaker by litmus during Victoria cycle. Victoria and older releases were already marked EOL, so we have no open branch using beaker now. Change-Id: I0e7e7a259e2db2f1a572fa04bbcb3e11b445ae6b --- doc/source/contributor/ci.rst | 14 +------ doc/source/contributor/coding-style.rst | 4 +- doc/source/contributor/testing.rst | 52 +------------------------ 3 files changed, 5 insertions(+), 65 deletions(-) diff --git a/doc/source/contributor/ci.rst b/doc/source/contributor/ci.rst index 8f187c8..eafceb8 100644 --- a/doc/source/contributor/ci.rst +++ b/doc/source/contributor/ci.rst @@ -45,23 +45,11 @@ OpenStack modules: The code that configures Jenkins jobs is hosted by job is non-voting, please raise a bug in Launchpad to make sure someone has a look and maybe update the module to work with latest version of Puppet. - * - puppet-openstack-beaker-*N*-*platform* - - Beaker jobs to do functional testing. It will prepare the Puppet - environment on 2 different systems (CentOS and Ubuntu), run - Puppet to configure the module resources and run some tests with - serverspec. - - Yes - - Read the job logs. Sometimes, the job fails because of packaging issues - or mirrors downtime. Please report a bug for this so we can find - workarounds. Otherwise, make sure your patch is supposed to work with - current tests or you'll have to adapt the tests to change the expected - behavior. `More documentation about Beaker - `__ * - puppet-openstack-litmus-*N*-*platform* - Litmus jobs to do functional testing. It will prepare the Puppet environment on 2 different systems (CentOS and Ubuntu), run Puppet to configure the module resources and run some tests with - serverspec. Litmus has replaced Beaker since Victoria release. + serverspec. - Yes - Read the job logs. Sometimes, the job fails because of packaging issues or mirrors downtime. Please report a bug for this so we can find diff --git a/doc/source/contributor/coding-style.rst b/doc/source/contributor/coding-style.rst index 61fd3cc..3414c25 100644 --- a/doc/source/contributor/coding-style.rst +++ b/doc/source/contributor/coding-style.rst @@ -9,12 +9,12 @@ Coding Style - Read this page - Make sure that what you're going to code is not already a work in progress -- Make sure you're familiar with Puppet Syntax, Lint_, Rspec_ and Beaker_ +- Make sure you're familiar with Puppet Syntax, Lint_, Rspec_ and Litmus_ - If you want to create a new module, read `New Module `_. .. _Lint: http://puppet-lint.com/ .. _Rspec: http://rspec-puppet.com/ -.. _Beaker: https://github.com/puppetlabs/beaker +.. _Litmus: https://puppetlabs.github.io/litmus/ Best practices diff --git a/doc/source/contributor/testing.rst b/doc/source/contributor/testing.rst index 53d8e00..64bf3b6 100644 --- a/doc/source/contributor/testing.rst +++ b/doc/source/contributor/testing.rst @@ -90,53 +90,5 @@ The best reference for getting started with rspec-puppet can be found here_. Functional Tests ================ -We use beaker to run functional tests, the best reference for getting started -with beaker can be found `here `__. - -Running beaker --------------- - -.. code:: bash - - #!/bin/bash - if [ -f /usr/bin/yum ]; then - sudo yum -y install libxml2-devel libxslt-devel ruby-devel - sudo yum -y groupinstall "Development Tools" - OS_TYPE='centos7' - elif [ -f /usr/bin/apt-get ]; then - sudo apt-get update - sudo apt-get install -y libxml2-dev libxslt-dev zlib1g-dev git ruby \ - ruby-dev build-essential - OS_TYPE='trusty' - fi - echo "" | sudo tee -a /etc/ssh/sshd_config - echo "Match address 127.0.0.1" | sudo tee -a /etc/ssh/sshd_config - echo " PermitRootLogin without-password" | sudo tee -a \ - /etc/ssh/sshd_config - echo "" | sudo tee -a /etc/ssh/sshd_config - echo "Match address ::1" | sudo tee -a /etc/ssh/sshd_config - echo " PermitRootLogin without-password" | sudo tee -a \ - /etc/ssh/sshd_config - mkdir -p .ssh - ssh-keygen -f ~/.ssh/id_rsa -b 2048 -C "beaker key" -P "" - sudo mkdir -p /root/.ssh - sudo rm /root/.ssh/authorized_keys - cat ~/.ssh/id_rsa.pub | sudo tee -a /root/.ssh/authorized_keys - if [ -f /usr/bin/yum ]; then - sudo systemctl restart sshd - elif [ -f /usr/bin/apt-get ]; then - sudo service ssh restart - fi - sudo gem install bundler --no-document --verbose - mkdir .bundled_gems - export GEM_HOME=`pwd`/.bundled_gems - bundle install - export BEAKER_set=nodepool-$OS_TYPE - export BEAKER_debug=yes - bundle exec rspec spec/acceptance - - -| - -The last command runs beaker tests by installing and testing the OpenStack -service. +We use litmus to run functional tests. See `the litmus documentation +__` to find its details.