puppet-retrospec 0.8.1 → 0.9.0

data/spec/fixtures/modules/staging/manifests/file.pp

@@ -0,0 +1,125 @@
+# #### Overview:
+#
+# Define resource to retrieve files to staging directories. It is
+# intententionally not replacing files, as these intend to be large binaries
+# that are versioned.
+#
+# #### Notes:
+#
+#   If you specify a different staging location, please manage the file
+#   resource as necessary.
+#
+define staging::file (
+  $source,              #: the source file location, supports local files, puppet://, http://, https://, ftp://, s3://
+  $target      = undef, #: the target file location, if unspecified ${staging::path}/${subdir}/${name}
+  $username    = undef, #: https or ftp username
+  $certificate = undef, #: https certificate file
+  $password    = undef, #: https or ftp user password or https certificate password
+  $environment = undef, #: environment variable for settings such as http_proxy, https_proxy, of ftp_proxy
+  $timeout     = undef, #: the the time to wait for the file transfer to complete
+  $curl_option = undef, #: options to pass to curl
+  $wget_option = undef, #: options to pass to wget
+  $tries       = undef, #: amount of retries for the file transfer when non transient connection errors exist
+  $try_sleep   = undef, #: time to wait between retries for the file transfer
+  $subdir      = $caller_module_name
+) {
+
+  include staging
+
+  $quoted_source = shellquote($source)
+
+  if $target {
+    $target_file = $target
+    $staging_dir = staging_parse($target, 'parent')
+  } else {
+    $staging_dir = "${staging::path}/${subdir}"
+    $target_file = "${staging_dir}/${name}"
+
+    if ! defined(File[$staging_dir]) {
+      file { $staging_dir:
+        ensure=>directory,
+      }
+    }
+  }
+
+  Exec {
+    path        => $staging::exec_path,
+    environment => $environment,
+    cwd         => $staging_dir,
+    creates     => $target_file,
+    timeout     => $timeout,
+    try_sleep   => $try_sleep,
+    tries       => $tries,
+    logoutput   => on_failure,
+  }
+
+  case $::staging_http_get {
+    'curl', default: {
+      $http_get        = "curl ${curl_option} -f -L -o ${target_file} ${quoted_source}"
+      $http_get_passwd = "curl ${curl_option} -f -L -o ${target_file} -u ${username}:${password} ${quoted_source}"
+      $http_get_cert   = "curl ${curl_option} -f -L -o ${target_file} -E ${certificate}:${password} ${quoted_source}"
+      $ftp_get         = "curl ${curl_option} -o ${target_file} ${quoted_source}"
+      $ftp_get_passwd  = "curl ${curl_option} -o ${target_file} -u ${username}:${password} ${quoted_source}"
+    }
+    'wget': {
+      $http_get        = "wget ${wget_option} -O ${target_file} ${quoted_source}"
+      $http_get_passwd = "wget ${wget_option} -O ${target_file} --user=${username} --password=${password} ${quoted_source}"
+      $http_get_cert   = "wget ${wget_option} -O ${target_file} --user=${username} --certificate=${certificate} ${quoted_source}"
+      $ftp_get         = $http_get
+      $ftp_get_passwd  = $http_get_passwd
+    }
+    'powershell':{
+      $http_get           = "powershell.exe -Command \"\$wc = New-Object System.Net.WebClient;\$wc.DownloadFile('${source}','${target_file}')\""
+      $ftp_get            = $http_get
+      $http_get_password  = "powershell.exe -Command \"\$wc = (New-Object System.Net.WebClient);\$wc.Credentials = New-Object System.Net.NetworkCredential('${username}','${password}');\$wc.DownloadFile(${source},${target_file})\""
+      $ftp_get_password   = $http_get_password
+    }
+  }
+
+  case $source {
+    /^\//: {
+      file { $target_file:
+        source  => $source,
+        replace => false,
+      }
+    }
+    /^puppet:\/\//: {
+      file { $target_file:
+        source  => $source,
+        replace => false,
+      }
+    }
+    /^http:\/\//: {
+      if $username { $command = $http_get_passwd }
+      else         { $command = $http_get        }
+      exec { $target_file:
+        command   => $command,
+      }
+    }
+    /^https:\/\//: {
+      if $username       { $command = $http_get_passwd }
+      elsif $certificate { $command = $http_get_cert   }
+      else               { $command = $http_get        }
+      exec { $target_file:
+        command => $command,
+      }
+    }
+    /^ftp:\/\//: {
+      if $username       { $command = $ftp_get_passwd }
+      else               { $command = $ftp_get        }
+      exec { $target_file:
+        command     => $command,
+      }
+    }
+    /^s3:\/\//: {
+      $command = "aws s3 cp ${source} ${target_file}"
+      exec { $target_file:
+        command   => $command,
+      }
+    }
+    default: {
+      fail("staging::file: do not recognize source ${source}.")
+    }
+  }
+
+}

data/spec/fixtures/modules/staging/manifests/init.pp

@@ -0,0 +1,31 @@
+#   This module manages staging and extraction of files from various sources.
+#
+# #### Actions:
+#
+#   Creates the root staging directory. By default files will be created in a subdirectory matching the caller_module_name.
+#
+#      /opt/staging/
+#                 |-- puppet
+#                 |   `-- puppet.enterprise.2.0.tar.gz
+#                 `-- tomcat
+#                     `-- tomcat.5.0.tar.gz
+#
+class staging (
+  $path      = $staging::params::path,     #: staging directory filepath
+  $owner     = $staging::params::owner,    #: staging directory owner
+  $group     = $staging::params::group,    #: staging directory group
+  $mode      = $staging::params::mode,     #: staging directory permission
+  $exec_path = $staging::params::exec_path #: executable default path
+) inherits staging::params {
+
+  # Resolve conflict with pe_staging
+  if !defined(File[$path]) {
+    file { $path:
+      ensure => directory,
+      owner  => $owner,
+      group  => $group,
+      mode   => $mode,
+    }
+  }
+
+}

data/spec/fixtures/modules/staging/manifests/params.pp

@@ -0,0 +1,33 @@
+# OS specific parameters
+class staging::params {
+  case $::osfamily {
+    default: {
+      $path      = '/opt/staging'
+      $owner     = '0'
+      $group     = '0'
+      $mode      = '0755'
+      $exec_path = '/usr/local/bin:/usr/bin:/bin'
+    }
+    'Solaris': {
+      $path      = '/opt/staging'
+      $owner     = '0'
+      $group     = '0'
+      $mode      = '0755'
+      $exec_path = '/usr/local/bin:/usr/bin:/bin:/usr/sfw/bin'
+    }
+    'windows': {
+      $path      = $::staging_windir
+      $owner     = 'S-1-5-32-544' # Adminstrators
+      $group     = 'S-1-5-18'     # SYSTEM
+      $mode      = '0660'
+      $exec_path = $::path
+    }
+    'FreeBSD': {
+      $path      = '/var/tmp/staging'
+      $owner     = '0'
+      $group     = '0'
+      $mode      = '0755'
+      $exec_path = '/usr/local/bin:/usr/bin:/bin'
+    }
+  }
+}

data/spec/fixtures/modules/staging/metadata.json

@@ -0,0 +1,106 @@
+{
+  "name": "nanliu-staging",
+  "version": "1.0.3",
+  "author": "Nan Liu",
+  "summary": "Compressed file staging and deployment",
+  "license": "Apache-2.0",
+  "source": "git://github.com/nanliu/puppet-staging",
+  "project_page": "https://github.com/nanliu/puppet-staging",
+  "issues_url": "https://github.com/nanliu/puppet-staging/issues",
+  "operatingsystem_support": [
+    {
+      "operatingsystem": "RedHat",
+      "operatingsystemrelease": [
+        "4",
+        "5",
+        "6"
+      ]
+    },
+    {
+      "operatingsystem": "CentOS",
+      "operatingsystemrelease": [
+        "4",
+        "5",
+        "6"
+      ]
+    },
+    {
+      "operatingsystem": "OracleLinux",
+      "operatingsystemrelease": [
+        "4",
+        "5",
+        "6"
+      ]
+    },
+    {
+      "operatingsystem": "Scientific",
+      "operatingsystemrelease": [
+        "4",
+        "5",
+        "6"
+      ]
+    },
+    {
+      "operatingsystem": "SLES",
+      "operatingsystemrelease": [
+        "11 SP1"
+      ]
+    },
+    {
+      "operatingsystem": "Debian",
+      "operatingsystemrelease": [
+        "6",
+        "7"
+      ]
+    },
+    {
+      "operatingsystem": "Ubuntu",
+      "operatingsystemrelease": [
+        "10.04",
+        "12.04"
+      ]
+    },
+    {
+      "operatingsystem": "Solaris",
+      "operatingsystemrelease": [
+        "10",
+        "11"
+      ]
+    },
+    {
+      "operatingsystem": "Windows",
+      "operatingsystemrelease": [
+        "Server 2003",
+        "Server 2003 R2",
+        "Server 2008",
+        "Server 2008 R2",
+        "Server 2012",
+        "Server 2012 R2",
+        "7",
+        "8"
+      ]
+    },
+    {
+      "operatingsystem": "AIX",
+      "operatingsystemrelease": [
+        "5.3",
+        "6.1",
+        "7.1"
+      ]
+    }
+  ],
+  "requirements": [
+    {
+      "name": "pe",
+      "version_requirement": "3.x"
+    },
+    {
+      "name": "puppet",
+      "version_requirement": ">=2.7.0 <4.0.0"
+    }
+  ],
+  "description": "Manages compressed file staging and deployment.",
+  "dependencies": [
+  
+  ]
+}

data/spec/fixtures/modules/staging/spec/defines/staging_deploy_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+describe 'staging::deploy', :type => :define do
+
+  # forcing a more sane caller_module_name to match real usage.
+  let(:facts) { { :caller_module_name => 'spec',
+                  :osfamily           => 'RedHat',
+                  :staging_http_get   => 'curl',
+                  :path               => '/usr/local/bin:/usr/bin:/bin', } }
+
+  describe 'when deploying tar.gz' do
+    let(:title) { 'sample.tar.gz' }
+    let(:params) { { :source => 'puppet:///modules/staging/sample.tar.gz',
+      :target => '/usr/local' } }
+
+    it {
+      should contain_file('/opt/staging')
+      should contain_file('/opt/staging/spec/sample.tar.gz')
+      should contain_exec('extract sample.tar.gz').with({
+        :command => 'tar xzf /opt/staging/spec/sample.tar.gz',
+        :path    => '/usr/local/bin:/usr/bin:/bin',
+        :cwd     => '/usr/local',
+        :creates => '/usr/local/sample'
+      })
+    }
+  end
+
+end

data/spec/fixtures/modules/staging/spec/defines/staging_extract_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+describe 'staging::extract', :type => :define do
+
+  # forcing a more sane caller_module_name to match real usage.
+  let(:facts) { { :caller_module_name => 'spec',
+                  :osfamily           => 'RedHat',
+                  :path               => '/usr/local/bin:/usr/bin:/bin' } }
+
+  describe 'when deploying tar.gz' do
+    let(:title) { 'sample.tar.gz' }
+    let(:params) { { :target => '/opt' } }
+
+    it {
+      should contain_file('/opt/staging')
+      should contain_exec('extract sample.tar.gz').with({
+        :command => 'tar xzf /opt/staging/spec/sample.tar.gz',
+        :path    => '/usr/local/bin:/usr/bin:/bin',
+        :cwd     => '/opt',
+        :creates => '/opt/sample'
+      })
+    }
+  end
+
+  describe 'when deploying tar.gz with strip' do
+    let(:title) { 'sample.tar.gz' }
+    let(:params) { { :target => '/opt',
+                     :strip  => 1, } }
+
+    it {
+      should contain_file('/opt/staging')
+      should contain_exec('extract sample.tar.gz').with({
+        :command => 'tar xzf /opt/staging/spec/sample.tar.gz --strip=1',
+        :path    => '/usr/local/bin:/usr/bin:/bin',
+        :cwd     => '/opt',
+        :creates => '/opt/sample'
+      })
+    }
+  end
+
+  describe 'when deploying zip' do
+    let(:title) { 'sample.zip' }
+    let(:params) { { :target => '/opt' } }
+
+    it { should contain_file('/opt/staging')
+      should contain_exec('extract sample.zip').with({
+        :command => 'unzip /opt/staging/spec/sample.zip',
+        :path    => '/usr/local/bin:/usr/bin:/bin',
+        :cwd     => '/opt',
+        :creates => '/opt/sample'
+      })
+    }
+  end
+
+  describe 'when deploying zip with strip (noop)' do
+    let(:title) { 'sample.zip' }
+    let(:params) { { :target => '/opt',
+                     :strip  => 1, } }
+
+    it { should contain_file('/opt/staging')
+      should contain_exec('extract sample.zip').with({
+        :command => 'unzip /opt/staging/spec/sample.zip',
+        :path    => '/usr/local/bin:/usr/bin:/bin',
+        :cwd     => '/opt',
+        :creates => '/opt/sample'
+      })
+    }
+  end
+
+  describe 'when deploying war' do
+    let(:title) { 'sample.war' }
+    let(:params) { { :target => '/opt' } }
+
+    it { should contain_file('/opt/staging')
+      should contain_exec('extract sample.war').with({
+        :command => 'jar xf /opt/staging/spec/sample.war',
+        :path    => '/usr/local/bin:/usr/bin:/bin',
+        :cwd     => '/opt',
+        :creates => '/opt/sample'
+      })
+    }
+  end
+
+  describe 'when deploying war with strip (noop)' do
+    let(:title) { 'sample.war' }
+    let(:params) { { :target => '/opt',
+                     :strip  => 1, } }
+
+    it { should contain_file('/opt/staging')
+      should contain_exec('extract sample.war').with({
+        :command => 'jar xf /opt/staging/spec/sample.war',
+        :path    => '/usr/local/bin:/usr/bin:/bin',
+        :cwd     => '/opt',
+        :creates => '/opt/sample'
+      })
+    }
+  end
+
+  describe 'when deploying unknown' do
+     let(:title) { 'sample.zzz'}
+     let(:params) { { :target => '/opt' } }
+
+     it { expect { should contain_exec("exec sample.zzz") }.to raise_error(Puppet::Error) }
+  end
+end

data/spec/fixtures/modules/staging/spec/defines/staging_file_spec.rb

@@ -0,0 +1,163 @@
+require 'spec_helper'
+describe 'staging::file', :type => :define do
+
+  # forcing a more sane caller_module_name to match real usage.
+  let(:facts) { { :caller_module_name => 'spec',
+                  :osfamily           => 'RedHat',
+                  :staging_http_get   => 'curl' } }
+
+  describe 'when deploying via puppet' do
+    let(:title) { 'sample.tar.gz' }
+    let(:params) { { :source => 'puppet:///modules/staging/sample.tar.gz' } }
+
+    it {
+      should contain_file('/opt/staging')
+      should contain_file('/opt/staging/spec/sample.tar.gz')
+      should_not contain_exec('/opt/staging/spec/sample.tar.gz')
+    }
+  end
+
+  describe 'when deploying via local' do
+    let(:title) { 'sample.tar.gz' }
+    let(:params) { { :source => '/nfs/sample.tar.gz',
+      :target => '/usr/local/sample.tar.gz',
+    } }
+
+    it {
+      should contain_file('/opt/staging')
+      should contain_file('/usr/local/sample.tar.gz')
+      should_not contain_exec('/opt/staging/spec/sample.tar.gz')
+    }
+  end
+
+  describe 'when deploying via http' do
+    let(:title) { 'sample.tar.gz' }
+    let(:params) { { :source => 'http://webserver/sample.tar.gz' } }
+
+    it {
+      should contain_file('/opt/staging')
+      should contain_exec('/opt/staging/spec/sample.tar.gz').with( {
+        :command => 'curl  -f -L -o /opt/staging/spec/sample.tar.gz http://webserver/sample.tar.gz',
+        :path        => '/usr/local/bin:/usr/bin:/bin',
+        :environment => nil,
+        :cwd         => '/opt/staging/spec',
+        :creates     => '/opt/staging/spec/sample.tar.gz',
+        :logoutput   => 'on_failure',
+      })
+    }
+  end
+
+  describe 'when deploying via http with custom curl options' do
+    let(:title) { 'sample.tar.gz' }
+    let(:params) { {
+      :source => 'http://webserver/sample.tar.gz',
+      :curl_option => '-b',
+    } }
+
+    it {
+      should contain_file('/opt/staging')
+      should contain_exec('/opt/staging/spec/sample.tar.gz').with( {
+        :command => 'curl -b -f -L -o /opt/staging/spec/sample.tar.gz http://webserver/sample.tar.gz',
+        :path        => '/usr/local/bin:/usr/bin:/bin',
+        :environment => nil,
+        :cwd         => '/opt/staging/spec',
+        :creates     => '/opt/staging/spec/sample.tar.gz',
+        :logoutput   => 'on_failure',
+      })
+    }
+  end
+
+  describe 'when deploying via http with parameters' do
+    let(:title) { 'sample.tar.gz' }
+    let(:params) { { :source => 'http://webserver/sample.tar.gz',
+      :target    => '/usr/local/sample.tar.gz',
+      :tries     => '10',
+      :try_sleep => '6',
+    } }
+
+    it { should contain_file('/opt/staging')
+      should contain_exec('/usr/local/sample.tar.gz').with( {
+        :command => 'curl  -f -L -o /usr/local/sample.tar.gz http://webserver/sample.tar.gz',
+        :path        => '/usr/local/bin:/usr/bin:/bin',
+        :environment => nil,
+        :cwd         => '/usr/local',
+        :creates     => '/usr/local/sample.tar.gz',
+        :tries       => '10',
+        :try_sleep   => '6',
+      })
+    }
+  end
+
+  describe 'when deploying via https' do
+     let(:title) { 'sample.tar.gz' }
+     let(:params) { { :source => 'https://webserver/sample.tar.gz' } }
+
+     it { should contain_file('/opt/staging') }
+     it { should contain_exec('/opt/staging/spec/sample.tar.gz').with( {
+       :command => 'curl  -f -L -o /opt/staging/spec/sample.tar.gz https://webserver/sample.tar.gz',
+       :path        => '/usr/local/bin:/usr/bin:/bin',
+       :environment => nil,
+       :cwd         => '/opt/staging/spec',
+       :creates     => '/opt/staging/spec/sample.tar.gz',
+       :logoutput   => 'on_failure',
+     }) }
+  end
+
+  describe 'when deploying via https with parameters' do
+    let(:title) { 'sample.tar.gz' }
+    let(:params) { { :source => 'https://webserver/sample.tar.gz',
+      :username => 'puppet',
+      :password => 'puppet',
+    } }
+
+    it {
+      should contain_file('/opt/staging')
+      should contain_exec('/opt/staging/spec/sample.tar.gz').with( {
+        :command => 'curl  -f -L -o /opt/staging/spec/sample.tar.gz -u puppet:puppet https://webserver/sample.tar.gz',
+        :path        => '/usr/local/bin:/usr/bin:/bin',
+        :environment => nil,
+        :cwd         => '/opt/staging/spec',
+        :creates     => '/opt/staging/spec/sample.tar.gz',
+        :logoutput   => 'on_failure',
+      })
+    }
+  end
+
+  describe 'when deploying via ftp' do
+    let(:title) { 'sample.tar.gz' }
+    let(:params) { { :source => 'ftp://webserver/sample.tar.gz' } }
+
+    it {
+      should contain_file('/opt/staging')
+      should contain_exec('/opt/staging/spec/sample.tar.gz').with( {
+        :command => 'curl  -o /opt/staging/spec/sample.tar.gz ftp://webserver/sample.tar.gz',
+        :path        => '/usr/local/bin:/usr/bin:/bin',
+        :environment => nil,
+        :cwd         => '/opt/staging/spec',
+        :creates     => '/opt/staging/spec/sample.tar.gz',
+        :logoutput   => 'on_failure',
+      })
+    }
+  end
+
+  describe 'when deploying via ftp with parameters' do
+    let(:title) { 'sample.tar.gz' }
+    let(:params) { { :source => 'ftp://webserver/sample.tar.gz',
+      :username => 'puppet',
+      :password => 'puppet',
+    } }
+
+    it {
+      should contain_file('/opt/staging')
+      should contain_exec('/opt/staging/spec/sample.tar.gz').with( {
+        :command => 'curl  -o /opt/staging/spec/sample.tar.gz -u puppet:puppet ftp://webserver/sample.tar.gz',
+        :path        => '/usr/local/bin:/usr/bin:/bin',
+        :environment => nil,
+        :cwd         => '/opt/staging/spec',
+        :creates     => '/opt/staging/spec/sample.tar.gz',
+        :logoutput   => 'on_failure',
+      })
+    }
+  end
+
+end