├── .rspec ├── lib ├── beaker-template │ ├── version.rb │ └── helpers.rb └── beaker-template.rb ├── .simplecov ├── spec ├── spec_helper.rb ├── beaker_test_helpers.rb ├── beaker-template │ └── helpers_spec.rb └── helpers.rb ├── acceptance ├── config │ └── nodes │ │ └── vagrant-ubuntu-1404.yml └── tests │ └── first.rb ├── .gitignore ├── Gemfile ├── bin └── beaker-template ├── beaker-template.gemspec ├── Rakefile ├── README.md └── LICENSE /.rspec: -------------------------------------------------------------------------------- 1 | --format documentation 2 | --color 3 | --tty 4 | -------------------------------------------------------------------------------- /lib/beaker-template/version.rb: -------------------------------------------------------------------------------- 1 | module Beaker 2 | module DSL 3 | module Template 4 | 5 | module Version 6 | STRING = '0.0.1rc0' 7 | end 8 | 9 | end 10 | end 11 | end 12 | -------------------------------------------------------------------------------- /.simplecov: -------------------------------------------------------------------------------- 1 | SimpleCov.configure do 2 | add_filter 'spec/' 3 | add_filter 'vendor/' 4 | add_filter do |file| 5 | file.lines_of_code < 10 6 | end 7 | end 8 | 9 | SimpleCov.start if ENV['BEAKER_TEMPLATE_COVERAGE'] 10 | -------------------------------------------------------------------------------- /lib/beaker-template/helpers.rb: -------------------------------------------------------------------------------- 1 | module Beaker 2 | module DSL 3 | module Template 4 | module Helpers 5 | 6 | # include your helper methods here as simple method definitions 7 | 8 | end 9 | end 10 | end 11 | end 12 | -------------------------------------------------------------------------------- /spec/spec_helper.rb: -------------------------------------------------------------------------------- 1 | require 'simplecov' 2 | require 'beaker_test_helpers' 3 | require 'beaker-template' 4 | require 'helpers' 5 | 6 | require 'rspec/its' 7 | 8 | RSpec.configure do |config| 9 | config.include TestFileHelpers 10 | config.include HostHelpers 11 | end -------------------------------------------------------------------------------- /acceptance/config/nodes/vagrant-ubuntu-1404.yml: -------------------------------------------------------------------------------- 1 | HOSTS: 2 | ubuntu-server-1404-x64: 3 | roles: 4 | - master 5 | platform: ubuntu-14.04-amd64 6 | box: puppetlabs/ubuntu-14.04-64-nocm 7 | box_url: https://vagrantcloud.com/puppetlabs/boxes/ubuntu-14.04-64-nocm 8 | hypervisor: vagrant 9 | -------------------------------------------------------------------------------- /acceptance/tests/first.rb: -------------------------------------------------------------------------------- 1 | 2 | # Acceptance level testing goes into files in the tests directory like this one, 3 | # Each file corresponding to a new test made up of individual testing steps 4 | test_name "Template Acceptance Test Example" 5 | 6 | step "Fail fast!" 7 | 8 | fail_test("There are no acceptance tests yet!") -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.swp 2 | log/* 3 | !.gitignore 4 | junit 5 | acceptance-tests 6 | pkg 7 | Gemfile.lock 8 | options.rb 9 | test.cfg 10 | .yardoc 11 | coverage 12 | .bundle 13 | .vendor 14 | _vendor 15 | tmp/ 16 | doc 17 | # JetBrains IDEA 18 | *.iml 19 | .idea/ 20 | # rbenv file 21 | .ruby-version 22 | .ruby-gemset 23 | # Vagrant folder 24 | .vagrant/ 25 | .vagrant_files/ 26 | -------------------------------------------------------------------------------- /spec/beaker_test_helpers.rb: -------------------------------------------------------------------------------- 1 | # These are specifically to mock Beaker methods necessary for testing 2 | # that will be available during runtime because this is never run separate 3 | # from Beaker itself. 4 | # 5 | # Including Beaker as a dependency would not work as a solution to this issue, 6 | # since that would make a cycle in the dependency graph, at least until 7 | # Beaker 3.0 happens and this is no longer a dependency of Beaker's. 8 | module BeakerTestHelpers 9 | include Beaker::DSL 10 | end 11 | 12 | module Beaker 13 | module DSL 14 | def self.register( helper ) 15 | end 16 | end 17 | end -------------------------------------------------------------------------------- /spec/beaker-template/helpers_spec.rb: -------------------------------------------------------------------------------- 1 | require 'spec_helper' 2 | 3 | class ClassMixedWithDSLHelpers 4 | include BeakerTestHelpers 5 | include Beaker::DSL::Template::Helpers 6 | 7 | def logger 8 | RSpec::Mocks::Double.new('logger').as_null_object 9 | end 10 | 11 | end 12 | 13 | describe ClassMixedWithDSLHelpers do 14 | 15 | describe 'release conditions' do 16 | 17 | it 'has updated the version number from the original template' do 18 | expect( Beaker::DSL::Template::Version::STRING ).to_not be === '0.0.1rc0' 19 | end 20 | 21 | it 'has a MAINTAINERS doc' do 22 | expect( File.exist?( 'MAINTAINERS' ) ).to be_truthy 23 | end 24 | 25 | end 26 | end 27 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source ENV['GEM_SOURCE'] || "https://rubygems.org" 2 | 3 | gemspec 4 | 5 | 6 | 7 | def location_for(place, fake_version = nil) 8 | if place =~ /^(git:[^#]*)#(.*)/ 9 | [fake_version, { :git => $1, :branch => $2, :require => false }].compact 10 | elsif place =~ /^file:\/\/(.*)/ 11 | ['>= 0', { :path => File.expand_path($1), :require => false }] 12 | else 13 | [place, { :require => false }] 14 | end 15 | end 16 | 17 | 18 | # We don't put beaker in as a test dependency because we 19 | # don't want to create a transitive dependency 20 | group :acceptance_testing do 21 | gem "beaker", *location_for(ENV['BEAKER_VERSION'] || '~> 3.0') 22 | end 23 | 24 | 25 | if File.exists? "#{__FILE__}.local" 26 | eval(File.read("#{__FILE__}.local"), binding) 27 | end 28 | -------------------------------------------------------------------------------- /lib/beaker-template.rb: -------------------------------------------------------------------------------- 1 | require 'stringify-hash' 2 | require 'beaker-template/helpers' 3 | require 'beaker-template/version' 4 | 5 | 6 | module Beaker 7 | module DSL 8 | module Template 9 | 10 | # include your modules from the beaker-template folder. Example below: 11 | include Beaker::DSL::Template::Helpers 12 | 13 | end 14 | end 15 | end 16 | 17 | 18 | # Boilerplate DSL inclusion mechanism: 19 | # First we register our module with the Beaker DSL 20 | Beaker::DSL.register( Beaker::DSL::Template ) 21 | # Modules added into a module which has previously been included are not 22 | # retroactively included in the including class. 23 | # 24 | # https://github.com/adrianomitre/retroactive_module_inclusion 25 | Beaker::TestCase.class_eval { include Beaker::DSL } 26 | -------------------------------------------------------------------------------- /bin/beaker-template: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | require 'rubygems' unless defined?(Gem) 4 | require 'beaker-template' 5 | 6 | VERSION_STRING = 7 | " 8 | _ .--. 9 | ( ` ) 10 | beaker-template .-' `--, 11 | _..----.. ( )`-. 12 | .'_|` _|` _|( .__, ) 13 | /_| _| _| _( (_, .-' 14 | ;| _| _| _| '-'__,--'`--' 15 | | _| _| _| _| | 16 | _ || _| _| _| _| %s 17 | _( `--.\\_| _| _| _|/ 18 | .-' )--,| _| _|.` 19 | (__, (_ ) )_| _| / 20 | `-.__.\\ _,--'\\|__|__/ 21 | ;____; 22 | \\YT/ 23 | || 24 | |\"\"| 25 | '==' 26 | " 27 | 28 | 29 | 30 | puts VERSION_STRING % [Beaker::DSL::Helpers::Template::Version::STRING] 31 | 32 | exit 0 33 | -------------------------------------------------------------------------------- /beaker-template.gemspec: -------------------------------------------------------------------------------- 1 | # -*- encoding: utf-8 -*- 2 | $LOAD_PATH.unshift File.expand_path("../lib", __FILE__) 3 | require 'beaker-template/version' 4 | 5 | Gem::Specification.new do |s| 6 | s.name = "beaker-template" 7 | s.version = Beaker::DSL::Template::Version::STRING 8 | s.authors = ["Puppetlabs"] 9 | s.email = ["qe-team@puppetlabs.com"] 10 | s.homepage = "https://github.com/puppetlabs/beaker-template" 11 | s.summary = %q{Beaker DSL Extension Helpers!} 12 | s.description = %q{For use for the Beaker acceptance testing tool} 13 | s.license = 'Apache2' 14 | 15 | s.files = `git ls-files`.split("\n") 16 | s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n") 17 | s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) } 18 | s.require_paths = ["lib"] 19 | 20 | # Testing dependencies 21 | s.add_development_dependency 'rspec', '~> 3.0' 22 | s.add_development_dependency 'rspec-its' 23 | s.add_development_dependency 'fakefs', '~> 0.6' 24 | s.add_development_dependency 'rake', '~> 10.1' 25 | s.add_development_dependency 'simplecov' 26 | s.add_development_dependency 'pry', '~> 0.10' 27 | 28 | # Documentation dependencies 29 | s.add_development_dependency 'yard' 30 | s.add_development_dependency 'markdown' 31 | s.add_development_dependency 'thin' 32 | 33 | # Run time dependencies 34 | s.add_runtime_dependency 'stringify-hash', '~> 0.0.0' 35 | 36 | end 37 | 38 | -------------------------------------------------------------------------------- /spec/helpers.rb: -------------------------------------------------------------------------------- 1 | module TestFileHelpers 2 | def create_files file_array 3 | file_array.each do |f| 4 | FileUtils.mkdir_p File.dirname(f) 5 | FileUtils.touch f 6 | end 7 | end 8 | 9 | def fog_file_contents 10 | { :default => { :aws_access_key_id => "IMANACCESSKEY", 11 | :aws_secret_access_key => "supersekritkey", 12 | :aix_hypervisor_server => "aix_hypervisor.labs.net", 13 | :aix_hypervisor_username => "aixer", 14 | :aix_hypervisor_keyfile => "/Users/user/.ssh/id_rsa-acceptance", 15 | :solaris_hypervisor_server => "solaris_hypervisor.labs.net", 16 | :solaris_hypervisor_username => "harness", 17 | :solaris_hypervisor_keyfile => "/Users/user/.ssh/id_rsa-old.private", 18 | :solaris_hypervisor_vmpath => "rpoooool/zs", 19 | :solaris_hypervisor_snappaths => ["rpoooool/USER/z0"], 20 | :vsphere_server => "vsphere.labs.net", 21 | :vsphere_username => "vsphere@labs.com", 22 | :vsphere_password => "supersekritpassword"} } 23 | end 24 | 25 | end 26 | 27 | module HostHelpers 28 | HOST_DEFAULTS = { :platform => 'unix', 29 | :snapshot => 'pe', 30 | :box => 'box_name', 31 | :roles => ['agent'], 32 | :snapshot => 'snap', 33 | :ip => 'default.ip.address', 34 | :box => 'default_box_name', 35 | :box_url => 'http://default.box.url', 36 | } 37 | 38 | HOST_NAME = "vm%d" 39 | HOST_SNAPSHOT = "snapshot%d" 40 | HOST_IP = "ip.address.for.%s" 41 | HOST_BOX = "%s_of_my_box" 42 | HOST_BOX_URL = "http://address.for.my.box.%s" 43 | HOST_TEMPLATE = "%s_has_a_template" 44 | 45 | def logger 46 | double( 'logger' ).as_null_object 47 | end 48 | 49 | def make_opts 50 | opts = StringifyHash.new 51 | opts.merge( { :logger => logger, 52 | :host_config => 'sample.config', 53 | :type => nil, 54 | :pooling_api => 'http://vcloud.delivery.puppetlabs.net/', 55 | :datastore => 'instance0', 56 | :folder => 'Delivery/Quality Assurance/Staging/Dynamic', 57 | :resourcepool => 'delivery/Quality Assurance/Staging/Dynamic', 58 | :gce_project => 'beaker-compute', 59 | :gce_keyfile => '/path/to/keyfile.p12', 60 | :gce_password => 'notasecret', 61 | :gce_email => '12345678910@developer.gserviceaccount.com' } ) 62 | end 63 | 64 | def generate_result (name, opts ) 65 | result = double( 'result' ) 66 | stdout = opts.has_key?(:stdout) ? opts[:stdout] : name 67 | stderr = opts.has_key?(:stderr) ? opts[:stderr] : name 68 | exit_code = opts.has_key?(:exit_code) ? opts[:exit_code] : 0 69 | exit_code = [exit_code].flatten 70 | allow( result ).to receive( :stdout ).and_return( stdout ) 71 | allow( result ).to receive( :stderr ).and_return( stderr ) 72 | allow( result ).to receive( :exit_code ).and_return( *exit_code ) 73 | result 74 | end 75 | 76 | def make_host_opts name, opts 77 | make_opts.merge( { 'HOSTS' => { name => opts } } ).merge( opts ) 78 | end 79 | 80 | def make_host name, host_hash 81 | host_hash = StringifyHash.new.merge(HOST_DEFAULTS.merge(host_hash)) 82 | 83 | host = make_opts.merge(host_hash) 84 | 85 | allow(host).to receive( :name ).and_return( name ) 86 | allow(host).to receive( :to_s ).and_return( name ) 87 | allow(host).to receive( :exec ).and_return( generate_result( name, host_hash ) ) 88 | host 89 | end 90 | 91 | def make_hosts preset_opts = {}, amt = 3 92 | hosts = [] 93 | (1..amt).each do |num| 94 | name = HOST_NAME % num 95 | opts = { :snapshot => HOST_SNAPSHOT % num, 96 | :ip => HOST_IP % name, 97 | :template => HOST_TEMPLATE % name, 98 | :box => HOST_BOX % name, 99 | :box_url => HOST_BOX_URL % name }.merge( preset_opts ) 100 | hosts << make_host(name, opts) 101 | end 102 | hosts 103 | end 104 | 105 | def make_instance instance_data = {} 106 | OpenStruct.new instance_data 107 | end 108 | 109 | end 110 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | require 'rspec/core/rake_task' 2 | 3 | namespace :test do 4 | 5 | namespace :spec do 6 | 7 | desc "Run spec tests" 8 | RSpec::Core::RakeTask.new(:run) do |t| 9 | t.rspec_opts = ['--color'] 10 | t.pattern = 'spec/' 11 | end 12 | 13 | desc "Run spec tests with coverage" 14 | RSpec::Core::RakeTask.new(:coverage) do |t| 15 | ENV['BEAKER_TEMPLATE_COVERAGE'] = 'y' 16 | t.rspec_opts = ['--color'] 17 | t.pattern = 'spec/' 18 | end 19 | 20 | end 21 | 22 | namespace :acceptance do 23 | 24 | desc <<-EOS 25 | A quick acceptance test, named because it has no pre-suites to run 26 | EOS 27 | task :quick do 28 | 29 | sh("beaker", 30 | "--hosts", ENV['CONFIG'] || "acceptance/config/nodes/vagrant-ubuntu-1404.yml", 31 | "--tests", "acceptance/tests", 32 | "--log-level", "debug", 33 | "--keyfile", ENV['KEY'] || "#{ENV['HOME']}/.ssh/id_rsa") 34 | end 35 | 36 | end 37 | 38 | end 39 | 40 | # namespace-named default tasks. 41 | # these are the default tasks invoked when only the namespace is referenced. 42 | # they're needed because `task :default` in those blocks doesn't work as expected. 43 | task 'test:spec' => 'test:spec:run' 44 | task 'test:acceptance' => 'test:acceptance:quick' 45 | 46 | # global defaults 47 | task :test => 'test:spec' 48 | task :default => :test 49 | 50 | ########################################################### 51 | # 52 | # Documentation Tasks 53 | # 54 | ########################################################### 55 | DOCS_DAEMON = "yard server --reload --daemon --server thin" 56 | FOREGROUND_SERVER = 'bundle exec yard server --reload --verbose --server thin lib/beaker' 57 | 58 | def running?( cmdline ) 59 | ps = `ps -ef` 60 | found = ps.lines.grep( /#{Regexp.quote( cmdline )}/ ) 61 | if found.length > 1 62 | raise StandardError, "Found multiple YARD Servers. Don't know what to do." 63 | end 64 | 65 | yes = found.empty? ? false : true 66 | return yes, found.first 67 | end 68 | 69 | def pid_from( output ) 70 | output.squeeze(' ').strip.split(' ')[1] 71 | end 72 | 73 | desc 'Start the documentation server in the foreground' 74 | task :docs => 'docs:clear' do 75 | original_dir = Dir.pwd 76 | Dir.chdir( File.expand_path(File.dirname(__FILE__)) ) 77 | sh FOREGROUND_SERVER 78 | Dir.chdir( original_dir ) 79 | end 80 | 81 | namespace :docs do 82 | 83 | desc 'Clear the generated documentation cache' 84 | task :clear do 85 | original_dir = Dir.pwd 86 | Dir.chdir( File.expand_path(File.dirname(__FILE__)) ) 87 | sh 'rm -rf docs' 88 | Dir.chdir( original_dir ) 89 | end 90 | 91 | desc 'Generate static documentation' 92 | task :gen => 'docs:clear' do 93 | original_dir = Dir.pwd 94 | Dir.chdir( File.expand_path(File.dirname(__FILE__)) ) 95 | output = `bundle exec yard doc` 96 | puts output 97 | if output =~ /\[warn\]|\[error\]/ 98 | fail "Errors/Warnings during yard documentation generation" 99 | end 100 | Dir.chdir( original_dir ) 101 | end 102 | 103 | desc 'Run the documentation server in the background, alias `bg`' 104 | task :background => 'docs:clear' do 105 | yes, output = running?( DOCS_DAEMON ) 106 | if yes 107 | puts "Not starting a new YARD Server..." 108 | puts "Found one running with pid #{pid_from( output )}." 109 | else 110 | original_dir = Dir.pwd 111 | Dir.chdir( File.expand_path(File.dirname(__FILE__)) ) 112 | sh "bundle exec #{DOCS_DAEMON}" 113 | Dir.chdir( original_dir ) 114 | end 115 | end 116 | 117 | task(:bg) { Rake::Task['docs:background'].invoke } 118 | 119 | desc 'Check the status of the documentation server' 120 | task :status do 121 | yes, output = running?( DOCS_DAEMON ) 122 | if yes 123 | pid = pid_from( output ) 124 | puts "Found a YARD Server running with pid #{pid}" 125 | else 126 | puts "Could not find a running YARD Server." 127 | end 128 | end 129 | 130 | desc "Stop a running YARD Server" 131 | task :stop do 132 | yes, output = running?( DOCS_DAEMON ) 133 | if yes 134 | pid = pid_from( output ) 135 | puts "Found a YARD Server running with pid #{pid}" 136 | `kill #{pid}` 137 | puts "Stopping..." 138 | yes, output = running?( DOCS_DAEMON ) 139 | if yes 140 | `kill -9 #{pid}` 141 | yes, output = running?( DOCS_DAEMON ) 142 | if yes 143 | puts "Could not Stop Server!" 144 | else 145 | puts "Server stopped." 146 | end 147 | else 148 | puts "Server stopped." 149 | end 150 | else 151 | puts "Could not find a running YARD Server" 152 | end 153 | end 154 | end 155 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # beaker-template 2 | 3 | Let's construct a Beaker DSL extension library! 4 | 5 | # Why Would We Do Such a Thing? 6 | 7 | There are two reasons to create a Beaker library: 8 | 9 | 1. To pull functionality out of Beaker core to be maintained/improved separately (mostly QE tasks) 10 | 2. To provide additional methods to the Beaker DSL, extending Beaker functionality (biggest Beaker user use case) 11 | 12 | These instructions are here to give people a working guide on how to create your own Beaker 13 | libraries for the second use case. If you'd like to pull functionality out of Beaker 14 | (the first use case), then please create a 15 | [Beaker JIRA](https://tickets.puppetlabs.com/browse/BKR) 16 | ticket for it, and we can discuss that there. 17 | 18 | # Just tell me [how](#howto) 19 | 20 | # When to create a beaker-library: 21 | * code smells 22 | * repeated code across repos 23 | * methods duplicated from beaker 24 | * no/little tests, no CI for tests 25 | * when functionality is specific to software under test 26 | * But is useful across multiple projects, testing libraries 27 | * And does not belong in Beaker-core 28 | * e.g.: It is not host abstraction, provisioning, nor test-running 29 | * when functionality is specific to puppetlabs or other non-provisioning infrastructure 30 | 31 | # When to _not_ create a beaker-library 32 | * when changes belong in a beaker-core 33 | * provisioning 34 | * Host-abstraction (communication, information) 35 | * test running, assertions 36 | https://tickets.puppetlabs.com/browse/BKR-334 37 | 38 | 39 | # Beaker Library Creation Process Overview 40 | 41 | 42 | This section covers the high-level process of creating a Beaker library. 43 | If you'd like to know more about a particular step, checkout its section below. 44 | 45 | 1. Clone this repo (beaker-template) 46 | 2. Rename the library 47 | 3. Create spec tests 48 | 4. Create acceptance tests 49 | 5. Publish your library! 50 | 51 | # Step Details 52 | 53 | ## 1. Clone this repo (beaker-template) 54 | 55 | No hidden tricks. Just do it, people! 56 | 57 | ## 2. Rename the library 58 | 59 | There are a number of steps required to make sure your library is namespaced & setup correctly: 60 | 61 | ### A. File structure changes 62 | 63 | The accepted naming pattern for Beaker libraries follows from 'beaker-template', 64 | where you change `template` to match the name of the library you're creating. Some 65 | examples would be `beaker-hiera`, `beaker-facter`, `beaker-puppet`, etc. 66 | 67 | Once you've chosen your library name, you'll have to change a number of files to 68 | match it. The main project folder, and the corresponding folder under `lib` will 69 | both have to be renamed. 70 | 71 | The `beaker-template.rb` file under what was `lib/beaker-template` will have to 72 | be changed to match this new name as well. 73 | 74 | ### B. Code changes 75 | 76 | The template provides you with the default module path `Beaker::DSL::Helpers::Template`. 77 | This path follows from the DSL pattern within Beaker, and `Beaker::DSL::Helpers` 78 | should stay at the front of your path. `Template` should be changed to the name 79 | of your project. This change will be needed in a number of places, and doing a 80 | general search-and-destroy for the word `Template` should cover it. 81 | 82 | `require` references will need to be updated as well. Searching and replacing 83 | all lines that include: 84 | 85 | require 'beaker-template 86 | 87 | should cover all uses of this. 88 | 89 | ### C. Gemspec changes 90 | 91 | The gemspec file has a few additional changes that will be required. 92 | 93 | It includes both the require and module path changes. 94 | 95 | A general audit of every line of the `beaker-template.gemspec` file should be done, 96 | which should include renaming it to the name of the project, and changing most, 97 | if not all, of the lines in the first block describing the library itself. 98 | 99 | ## 3. Create spec tests 100 | 101 | Spec tests all live under the `spec` folder. These are the default rake task, & 102 | so can be run with a simple `bundle exec rake`, as well as being fully specified 103 | by running `bundle exec rake test:spec:run` or using the `test:spec` task. 104 | 105 | There are also code coverage tests built into the template, which can be run 106 | with spec testing by running the `test:spec:coverage` rake task. 107 | 108 | These will fail by default. This is on purpose, as some test refactoring (and 109 | hopefully test addition) should be done prior to wanting to release a library. 110 | Please add more spec tests either in what started as `spec/beaker-template/helpers_spec.rb`, 111 | or create more spec testing files under `spec/beaker-template`, and they'll be 112 | included in spec testing automatically. 113 | 114 | ## 4. Create acceptance tests 115 | 116 | Acceptance tests live in the `acceptance/tests` folder. These are Beaker tests, 117 | & are dependent on having Beaker installed. Note that this will happen with a 118 | `bundle install` execution, but can be avoided if you're not looking to run 119 | acceptance tests by ignoring the `acceptance_testing` gem group. 120 | 121 | You can run the acceptance testing suite by invoking the `test:acceptance` rake 122 | task. It should be noted that this is a shortcut for the `test:acceptance:quick` 123 | task, which is named as such because it uses no pre-suite. This uses a default 124 | provided hosts file for acceptance under the `acceptance/config` directory. If 125 | you'd like to provide your own hosts file, set the `CONFIG` environment variable. 126 | 127 | Acceptance tests will also fail by default, for the same reason given above as 128 | spec tests. 129 | 130 | ## 5. Create documentation 131 | 132 | In our experience, the better the documentation, the easier to use a library 133 | usually is. A beginner version of documentation can simply link to the 134 | Rubydocs that will be generated automatically (example from 135 | [beaker-pe](https://github.com/puppetlabs/beaker-pe)): 136 | 137 | - [Rubydocs](http://www.rubydoc.info/github/puppetlabs/beaker-pe) contain the 138 | technical reference for APIs and other aspects of beaker-pe. They describe 139 | how it works and how to use it but assume that you have a basic understanding 140 | of key concepts. 141 | 142 | Add contributing guideline to your documentation. Our recommendation is to link 143 | beaker's contributing guide in your guideline. An example of what your 144 | contributing guideline could be: 145 | 146 | - To contriute to this library please follow beaker's [contributing guide.](https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md) 147 | 148 | If you want a fully fleshed out example of what a full documentation table of 149 | contents might look like, checkout 150 | [beaker's docs](https://github.com/puppetlabs/beaker/blob/master/docs/README.md). 151 | 152 | ## 6. Publish your library! 153 | 154 | _But wait_, you might be thinking, _what about developing the functionality?_ 155 | Sure, we expect that to happen before this step. But, we're figuring that naming 156 | it in an explicit step would get us into a debate over TDD, or just the relative 157 | positioning of development in general. Let's just say that you've gotten over 158 | that part at some point in the recent past. 159 | 160 | If you're a puppet employee who maintains a Beaker library, & you'd like to have 161 | that library tested & published using our internal tooling & infrastructure, open a 162 | [Beaker JIRA ticket](https://tickets.puppetlabs.com/browse/BKR) to do so, and we 163 | can talk about setting up the Jenkins jobs to get this tested & released using those. 164 | 165 | For someone outside the company who would like to run a similar process to what 166 | we do internally, we just maintain two kinds of jobs for each Beaker library: 167 | 168 | 1. Test jobs that invoke the rake tasks mentioned in the testing sections. These are targeted on submitted PRs. 169 | 2. Gem publish jobs that are only manually kicked to release new versions of the Beaker library gem. 170 | 171 | ## Notes 172 | 173 | ### When to Breaking-Change 174 | 175 | * if moving existing functionality out of beaker, first release should not be a breaking change in beaker 2.x 176 | * retain method and DSL naming and signature and the code move will be seamless to the user 177 | * add the new library to beaker’s gemspec file so it is pulled in appropriately 178 | * always deprecate first 179 | * This is a manual process for now 180 | * use logging as appropriate to notify users of deprecations 181 | * always conform to semver 182 | * [http://semver.org/] 183 | * TL;DR: libraries shall deprecate. Breaking changes only on major version increments 184 | * if existing helpers are not named consistently 185 | * we can mitigate changes by aliasing method names and deprecating 186 | * if existing helpers need conflicting parameter changes (method signature changes) 187 | 188 | ### Documentation and Discoverability 189 | 190 | Beaker DSL keywords and helper methods can be difficult to find. Beaker documentation best practices and improvements can improve discoverability for existing beaker functionality and libraries. 191 | New, published, libraries should be added to the Beaker library list in its [docs](https://github.com/puppetlabs/beaker/blob/master/docs/Beaker-Libraries.md) 192 | 193 | Hand-crafted (non yardoc) docs should be contained, in-repo, in Markdown, so as to be fully available and PR-able. 194 | PRs for beaker and libraries should not be accepted without yardoc changes, and beaker/docs, /docs changes. 195 | 196 | ## See also: 197 | * [beaker-windows](https://github.com/puppetlabs/beaker-windows) (a modern example) 198 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | --------------------------------------------------------------------------------