Try to use zuul-cloner to prepare fixtures

In OpenStack Infra, we would like to run Puppet unit tests that
sometimes depends on other Puppet OpenStack modules.
Example: a patch in puppet-openstacklib that needs to be tested in puppet-nova.

This patch modifies the Rakefile to:
* clean spec_prep and spec_clean Rake tasks
* use openstack/puppet-openstack-integration/install_modules_unit.sh script
  to clone modules.
* do not use .fixtures.yaml file to clone modules and rely on
  zuul-cloner or git.
* Add openstack/ in gitignore so we never commit the
  puppet-openstack-integration repository (can happen when spec_clean
  did not run but you want to submit the patch anyway)
* Allow to run a custom Puppetfile if PUPPETFILE env is exported. It
  will allow people to test the module with the dependencies they like,
  feature we had with .fixtures.yaml.

Also add 'r10k' to Gemfile.

That way, we will be able to use zuul dependencies and run tests accross
modules like we do with functional testing.

Change-Id: I154e5ab5623b932fc3c550f7969a39993f38a3cf
(cherry picked from commit 79cb000d22)

.gitignore

@@ -5,3 +5,4 @@ Gemfile.lock
 .vendor
 .bundle/
 vendor/
+openstack/

Gemfile

@@ -20,6 +20,10 @@ group :development, :test do
   gem 'webmock'
 end
 
+group :system_tests do
+  gem 'r10k',                         :require => 'false'
+end
+
 if puppetversion = ENV['PUPPET_GEM_VERSION']
   gem 'puppet', puppetversion, :require => false
 else

Rakefile

@@ -1,9 +1,86 @@
 require 'puppetlabs_spec_helper/rake_tasks'
 require 'puppet-lint/tasks/puppet-lint'
+require 'puppet-syntax/tasks/puppet-syntax'
+require 'json'
+
+modname = JSON.parse(open('metadata.json').read)['name'].split('-')[1]
 
 PuppetLint.configuration.fail_on_warnings = true
 PuppetLint.configuration.send('disable_80chars')
 PuppetLint.configuration.send('disable_class_parameter_defaults')
 
 task(:default).clear
-task :default => [:spec, :lint]
+task :default => [:spec]
+Rake::Task[:lint].clear
+PuppetLint::RakeTask.new :lint do |config|
+  config.ignore_paths = ["spec/**/*.pp", "vendor/**/*.pp"]
+  config.fail_on_warnings = true
+  config.log_format = '%{path}:%{linenumber}:%{KIND}: %{message}'
+  config.disable_checks = ["80chars", "class_inherits_from_params_class", "class_parameter_defaults", "only_variable_string"]
+end
+
+desc "Run acceptance tests"
+RSpec::Core::RakeTask.new(:acceptance) do |t|
+  t.pattern = 'spec/acceptance'
+end
+
+Rake::Task[:spec_prep].clear
+desc 'Create the fixtures directory'
+task :spec_prep do
+  # Allow to test the module with custom dependencies
+  # like you could do with .fixtures file
+  if ENV['PUPPETFILE']
+    puppetfile = ENV['PUPPETFILE']
+    if ENV['GEM_HOME']
+      gem_home    = ENV['GEM_HOME']
+      gem_bin_dir = "#{gem_home}" + '/bin/'
+    else
+      gem_bin_dir = ''
+    end
+    r10k = ['env']
+    r10k += ["PUPPETFILE=#{puppetfile}"]
+    r10k += ["PUPPETFILE_DIR=#{Dir.pwd}/spec/fixtures/modules"]
+    r10k += ["#{gem_bin_dir}r10k"]
+    r10k += ['puppetfile', 'install', '-v']
+    sh(*r10k)
+  else
+  # otherwise, use official OpenStack Puppetfile
+    zuul_ref = ENV['ZUUL_REF']
+    zuul_branch = ENV['ZUUL_BRANCH']
+    zuul_url = ENV['ZUUL_URL']
+    repo = 'openstack/puppet-openstack-integration'
+    rm_rf(repo)
+    if File.exists?('/usr/zuul-env/bin/zuul-cloner')
+      zuul_clone_cmd = ['/usr/zuul-env/bin/zuul-cloner']
+      zuul_clone_cmd += ['--cache-dir', '/opt/git']
+      zuul_clone_cmd += ['--zuul-ref', "#{zuul_ref}"]
+      zuul_clone_cmd += ['--zuul-branch', "#{zuul_branch}"]
+      zuul_clone_cmd += ['--zuul-url', "#{zuul_url}"]
+      zuul_clone_cmd += ['git://git.openstack.org', "#{repo}"]
+      sh(*zuul_clone_cmd)
+    else
+      sh("git clone https://git.openstack.org/#{repo} #{repo}")
+    end
+    script = ['env']
+    script += ["PUPPETFILE_DIR=#{Dir.pwd}/spec/fixtures/modules"]
+    script += ["ZUUL_REF=#{zuul_ref}"]
+    script += ["ZUUL_BRANCH=#{zuul_branch}"]
+    script += ["ZUUL_URL=#{zuul_url}"]
+    script += ['bash', "#{repo}/install_modules_unit.sh"]
+    sh(*script)
+  end
+  rm_rf("spec/fixtures/modules/#{modname}")
+  ln_s(Dir.pwd, "spec/fixtures/modules/#{modname}")
+  mkdir_p('spec/fixtures/manifests')
+  touch('spec/fixtures/manifests/site.pp')
+end
+
+Rake::Task[:spec_clean].clear
+desc 'Clean up the fixtures directory'
+task :spec_clean do
+  rm_rf('spec/fixtures/modules')
+  rm_rf('openstack')
+  if File.zero?('spec/fixtures/manifests/site.pp')
+    rm_f('spec/fixtures/manifests/site.pp')
+  end
+end