RubyGems - puppet-retrospec - Versions diffs - 0.8.1 → 0.9.0 - Mend

puppet-retrospec 0.8.1 → 0.9.0

Files changed (539) hide show

data/spec/fixtures/modules/staging/docs/file.html ADDED Viewed

@@ -0,0 +1,178 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=utf-8">
+  <title>file.pp</title>
+  <link rel="stylesheet" href="http://jashkenas.github.com/docco/resources/docco.css">
+</head>
+<body>
+<div id='container'>
+  <div id="background"></div>
+  <div id="jump_to">
+    Jump To &hellip;
+    <div id="jump_wrapper">
+      <div id="jump_page">
+          <a class="source" href="deploy.html">deploy.pp</a>
+          <a class="source" href="extract.html">extract.pp</a>
+          <a class="source" href="file.html">file.pp</a>
+          <a class="source" href="init.html">init.pp</a>
+      </div>
+    </div>
+  </div>
+  <table cellspacing=0 cellpadding=0>
+  <thead>
+    <tr>
+      <th class=docs><h1>file.pp</h1></th>
+      <th class=code></th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr id='section-Define:_staging::file'>
+      <td class=docs>
+        <div class="pilwrap">
+          <a class="pilcrow" href="#section-Define:_staging::file">&#182;</a>
+        </div>
+        <h3>Define: staging::file</h3>
+<h4>Overview:</h4>
+<p>Define resource to retrieve files to staging directories. It is
+intententionally not replacing files, as these intend to be large binaries
+that are versioned.</p>
+<h4>Notes:</h4>
+<p>  If you specify a different staging location, please manage the file
+  resource as necessary.</p>
+<h3>Parameters:</h3>
+<ul>
+<li>[<em>source</em>]:  the source file location, supports local files, puppet://, http://, https://, ftp:// (default: )</li>
+<li>[<em>target</em>]:  the target staging directory, if unspecified ${staging::path}/${caller_module_name} (default: undef)</li>
+<li>[<em>username</em>]:  https or ftp username (default: undef)</li>
+<li>[<em>certificate</em>]:  https certificate file (default: undef)</li>
+<li>[<em>password</em>]:  https or ftp user password or https certificate password (default: undef)</li>
+<li>[<em>environment</em>]:  environment variable for settings such as http_proxy, https_proxy, of ftp_proxy (default: undef)</li>
+<li>[<em>timeout</em>]:  the the time to wait for the file transfer to complete (default: undef)</li>
+<li>[<em>subdir</em>]:  (default: $caller_module_name)</li>
+</ul>
+<h3>Usage:</h3>
+<pre><code>$caller_module_name = 'demo'
+class { 'staging':
+  path =&gt; '/tmp/staging',
+}
+staging::file { 'sample':
+  source =&gt; 'puppet:///modules/staging/sample',
+}
+staging::file { 'passwd':
+  source =&gt; '/etc/passwd',
+}
+staging::file { 'manpage.html':
+  source =&gt; 'http://curl.haxx.se/docs/manpage.html',
+}
+</code></pre>
+      </td>
+      <td class=code>
+        <div class='highlight'><pre><span class="n">define</span> <span class="n">staging</span><span class="o">::</span><span class="n">file</span> <span class="p">(</span>
+  <span class="vg">$source</span><span class="p">,</span>
+  <span class="vg">$target</span>      <span class="o">=</span> <span class="k">undef</span><span class="p">,</span>
+  <span class="vg">$username</span>    <span class="o">=</span> <span class="k">undef</span><span class="p">,</span>
+  <span class="vg">$certificate</span> <span class="o">=</span> <span class="k">undef</span><span class="p">,</span>
+  <span class="vg">$password</span>    <span class="o">=</span> <span class="k">undef</span><span class="p">,</span>
+  <span class="vg">$environment</span> <span class="o">=</span> <span class="k">undef</span><span class="p">,</span>
+  <span class="vg">$timeout</span>     <span class="o">=</span> <span class="k">undef</span><span class="p">,</span>
+  <span class="vg">$subdir</span>      <span class="o">=</span> <span class="vg">$caller_module_name</span>
+<span class="p">)</span> <span class="p">{</span>
+  <span class="kp">include</span> <span class="n">staging</span>
+  <span class="k">if</span> <span class="vg">$target</span> <span class="p">{</span>
+    <span class="vg">$target_file</span> <span class="o">=</span> <span class="vg">$target</span>
+    <span class="vg">$staging_dir</span> <span class="o">=</span> <span class="n">staging_parse</span><span class="p">(</span><span class="vg">$target</span><span class="p">,</span> <span class="s1">&#39;parent&#39;</span><span class="p">)</span>
+  <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
+    <span class="vg">$staging_dir</span> <span class="o">=</span> <span class="s2">&quot;${staging::path}/${subdir}&quot;</span>
+    <span class="vg">$target_file</span> <span class="o">=</span> <span class="s2">&quot;${staging_dir}/${name}&quot;</span>
+    <span class="k">if</span> <span class="o">!</span> <span class="n">defined</span><span class="p">(</span><span class="no">File</span><span class="o">[</span><span class="vg">$staging_dir</span><span class="o">]</span><span class="p">)</span> <span class="p">{</span>
+      <span class="n">file</span> <span class="p">{</span> <span class="vg">$staging_dir</span><span class="p">:</span>
+        <span class="k">ensure</span><span class="o">=&gt;</span><span class="n">directory</span><span class="p">,</span>
+      <span class="p">}</span>
+    <span class="p">}</span>
+  <span class="p">}</span>
+  <span class="no">Exec</span> <span class="p">{</span>
+    <span class="n">path</span>        <span class="o">=&gt;</span> <span class="s1">&#39;/usr/local/bin:/usr/bin:/bin&#39;</span><span class="p">,</span>
+    <span class="n">environment</span> <span class="o">=&gt;</span> <span class="vg">$environment</span><span class="p">,</span>
+    <span class="n">cwd</span>         <span class="o">=&gt;</span> <span class="vg">$staging_dir</span><span class="p">,</span>
+    <span class="n">creates</span>     <span class="o">=&gt;</span> <span class="vg">$target_file</span><span class="p">,</span>
+    <span class="n">timeout</span>     <span class="o">=&gt;</span> <span class="vg">$timeout</span><span class="p">,</span>
+    <span class="n">logoutput</span>   <span class="o">=&gt;</span> <span class="n">on_failure</span><span class="p">,</span>
+  <span class="p">}</span>
+  <span class="k">case</span> <span class="vg">$source</span> <span class="p">{</span>
+    <span class="sr">/^\//</span><span class="p">:</span> <span class="p">{</span>
+      <span class="n">file</span> <span class="p">{</span> <span class="vg">$target_file</span><span class="p">:</span>
+        <span class="n">source</span>  <span class="o">=&gt;</span> <span class="vg">$source</span><span class="p">,</span>
+        <span class="n">replace</span> <span class="o">=&gt;</span> <span class="kp">false</span><span class="p">,</span>
+      <span class="p">}</span>
+    <span class="p">}</span>
+    <span class="sr">/^puppet:\/\//</span><span class="p">:</span> <span class="p">{</span>
+      <span class="n">file</span> <span class="p">{</span> <span class="vg">$target_file</span><span class="p">:</span>
+        <span class="n">source</span>  <span class="o">=&gt;</span> <span class="vg">$source</span><span class="p">,</span>
+        <span class="n">replace</span> <span class="o">=&gt;</span> <span class="kp">false</span><span class="p">,</span>
+      <span class="p">}</span>
+    <span class="p">}</span>
+    <span class="sr">/^http:\/\//</span><span class="p">:</span> <span class="p">{</span>
+      <span class="nb">exec</span> <span class="p">{</span> <span class="vg">$target_file</span><span class="p">:</span>
+        <span class="n">command</span>     <span class="o">=&gt;</span> <span class="s2">&quot;curl -L -o ${name} ${source}&quot;</span><span class="p">,</span>
+      <span class="p">}</span>
+    <span class="p">}</span>
+    <span class="sr">/^https:\/\//</span><span class="p">:</span> <span class="p">{</span>
+      <span class="k">if</span> <span class="vg">$username</span> <span class="p">{</span>
+        <span class="vg">$command</span> <span class="o">=</span> <span class="s2">&quot;curl -L -o ${name} -u ${username}:${password} ${source}&quot;</span>
+      <span class="p">}</span> <span class="k">elsif</span> <span class="vg">$certificate</span> <span class="p">{</span>
+        <span class="vg">$command</span> <span class="o">=</span> <span class="s2">&quot;curl -L -o ${name} -E ${certificate}:${password} ${source}&quot;</span>
+      <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
+        <span class="vg">$command</span> <span class="o">=</span> <span class="s2">&quot;curl -L -o ${name} ${source}&quot;</span>
+      <span class="p">}</span>
+      <span class="nb">exec</span> <span class="p">{</span> <span class="vg">$target_file</span><span class="p">:</span>
+        <span class="n">command</span>     <span class="o">=&gt;</span> <span class="vg">$command</span><span class="p">,</span>
+      <span class="p">}</span>
+    <span class="p">}</span>
+    <span class="sr">/^ftp:\/\//</span><span class="p">:</span> <span class="p">{</span>
+      <span class="k">if</span> <span class="vg">$username</span> <span class="p">{</span>
+        <span class="vg">$command</span> <span class="o">=</span> <span class="s2">&quot;curl -o ${name} -u ${username}:${password} ${source}&quot;</span>
+      <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
+        <span class="vg">$command</span> <span class="o">=</span> <span class="s2">&quot;curl -o ${name} ${source}&quot;</span>
+      <span class="p">}</span>
+      <span class="nb">exec</span> <span class="p">{</span> <span class="vg">$target_file</span><span class="p">:</span>
+        <span class="n">command</span>     <span class="o">=&gt;</span> <span class="vg">$command</span><span class="p">,</span>
+      <span class="p">}</span>
+    <span class="p">}</span>
+    <span class="n">default</span><span class="p">:</span> <span class="p">{</span>
+      <span class="nb">fail</span><span class="p">(</span><span class="s2">&quot;stage::file: do not recognize source ${source}.&quot;</span><span class="p">)</span>
+    <span class="p">}</span>
+  <span class="p">}</span>
+<span class="p">}</span></pre></div>
+      </td>
+    </tr>
+  </table>
+</div>
+</body>

data/spec/fixtures/modules/staging/docs/init.html ADDED Viewed

@@ -0,0 +1,87 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=utf-8">
+  <title>init.pp</title>
+  <link rel="stylesheet" href="http://jashkenas.github.com/docco/resources/docco.css">
+</head>
+<body>
+<div id='container'>
+  <div id="background"></div>
+  <div id="jump_to">
+    Jump To &hellip;
+    <div id="jump_wrapper">
+      <div id="jump_page">
+          <a class="source" href="deploy.html">deploy.pp</a>
+          <a class="source" href="extract.html">extract.pp</a>
+          <a class="source" href="file.html">file.pp</a>
+          <a class="source" href="init.html">init.pp</a>
+      </div>
+    </div>
+  </div>
+  <table cellspacing=0 cellpadding=0>
+  <thead>
+    <tr>
+      <th class=docs><h1>init.pp</h1></th>
+      <th class=code></th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr id='section-Class:_staging'>
+      <td class=docs>
+        <div class="pilwrap">
+          <a class="pilcrow" href="#section-Class:_staging">&#182;</a>
+        </div>
+        <h3>Class: staging</h3>
+<p>This module manages staging and extraction of files from various sources.</p>
+<h4>Actions:</h4>
+<p>Creates the root staging directory. By default files will be created in a subdirectory matching the caller_module_name.</p>
+<p>   /opt/staging/</p>
+<pre><code>          |-- puppet
+          |   `-- puppet.enterprise.2.0.tar.gz
+          `-- tomcat
+              `-- tomcat.5.0.tar.gz
+</code></pre>
+<h3>Parameters:</h3>
+<ul>
+<li>[<em>path</em>]:  staging directory filepath (default: &lsquo;/opt/staging&rsquo;)</li>
+<li>[<em>owner</em>]:  staging directory owner (default: &lsquo;0&rsquo;)</li>
+<li>[<em>group</em>]:  staging directory group (default: &lsquo;0&rsquo;)</li>
+<li>[<em>mode</em>]:  staging directory permission (default: &lsquo;0755&rsquo;)</li>
+</ul>
+<h3>Usage:</h3>
+<pre><code>include staging
+</code></pre>
+      </td>
+      <td class=code>
+        <div class='highlight'><pre><span class="k">class</span> <span class="n">staging</span> <span class="p">(</span>
+  <span class="vg">$path</span>  <span class="o">=</span> <span class="s1">&#39;/opt/staging&#39;</span><span class="p">,</span>
+  <span class="vg">$owner</span> <span class="o">=</span> <span class="s1">&#39;0&#39;</span><span class="p">,</span>
+  <span class="vg">$group</span> <span class="o">=</span> <span class="s1">&#39;0&#39;</span><span class="p">,</span>
+  <span class="vg">$mode</span>  <span class="o">=</span> <span class="s1">&#39;0755&#39;</span>
+<span class="p">)</span> <span class="p">{</span>
+  <span class="n">file</span> <span class="p">{</span> <span class="vg">$path</span><span class="p">:</span>
+    <span class="k">ensure</span> <span class="o">=&gt;</span> <span class="n">directory</span><span class="p">,</span>
+    <span class="n">owner</span>  <span class="o">=&gt;</span> <span class="vg">$owner</span><span class="p">,</span>
+    <span class="n">group</span>  <span class="o">=&gt;</span> <span class="vg">$group</span><span class="p">,</span>
+    <span class="n">mode</span>   <span class="o">=&gt;</span> <span class="vg">$mode</span><span class="p">,</span>
+  <span class="p">}</span>
+<span class="p">}</span></pre></div>
+      </td>
+    </tr>
+  </table>
+</div>
+</body>

data/spec/fixtures/modules/staging/files/sample ADDED Viewed

	@@ -0,0 +1 @@
1	+ sample file to test module.

data/spec/fixtures/modules/staging/files/sample.tar.bz2 ADDED Viewed

Binary file

data/spec/fixtures/modules/staging/files/sample.tar.gz ADDED Viewed

Binary file

data/spec/fixtures/modules/staging/lib/facter/staging_http_get.rb ADDED Viewed

@@ -0,0 +1,29 @@
+Facter.add("staging_http_get") do
+  setcode do
+    fact = nil
+    which = lambda do |cmd|
+      result = nil
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+          exe = File.join(path, "#{cmd}#{ext}")
+          result = exe if File.executable? exe
+          break if result
+        end
+        break if result
+      end
+      result
+    end
+    ['powershell', 'curl', 'wget'].each do |cmd|
+      available = which.call(cmd)
+      fact = available ? cmd : nil
+      break if fact
+    end
+    fact
+  end
+end

data/spec/fixtures/modules/staging/lib/facter/staging_windir.rb ADDED Viewed

@@ -0,0 +1,11 @@
+Facter.add(:staging_windir) do
+  confine :osfamily => :windows
+  setcode do
+    program_data = `echo %SYSTEMDRIVE%\\ProgramData`.chomp
+    if File.directory? program_data
+      "#{program_data}\\staging"
+    else
+      "C:\\staging"
+    end
+  end
+end

data/spec/fixtures/modules/staging/lib/puppet/parser/functions/scope_defaults.rb ADDED Viewed

@@ -0,0 +1,17 @@
+module Puppet::Parser::Functions
+  newfunction(:scope_defaults, :type => :rvalue, :doc => <<-EOS
+Determine if specified resource defaults have a attribute defined in
+current scope.
+EOS
+  ) do |arguments|
+    raise(Puppet::ParseError, "scope_defaults(): Wrong number of arguments " +
+      "given (#{arguments.size} for 2)") if arguments.size != 2
+    # auto capitalize puppet resource for lookup:
+    res_type = arguments[0].split('::').collect{ |x| x.capitalize }.join('::')
+    res_attr = arguments[1]
+    return self.lookupdefaults(res_type).has_key?(res_attr.to_sym)
+  end
+end

data/spec/fixtures/modules/staging/lib/puppet/parser/functions/staging_parse.rb ADDED Viewed

@@ -0,0 +1,36 @@
+require 'uri'
+module Puppet::Parser::Functions
+  newfunction(:staging_parse, :type => :rvalue, :doc => <<-EOS
+Parse filepath to retrieve information about the file.
+    EOS
+  ) do |arguments|
+    raise(Puppet::ParseError, "staging_parse(): Wrong number of arguments " +
+      "given (#{arguments.size} for 1, 2, 3)") if arguments.size < 1 || arguments.size > 3
+    source    = arguments[0]
+    path      = URI.parse(source.gsub('\\', '/')).path
+    raise Puppet::ParseError, "staging_parse(): #{source.inspect} has no URI " +
+      "'path' component" if path.nil?
+    info      = arguments[1] ? arguments[1] : 'filename'
+    extension = arguments[2] ? arguments[2] : File.extname(path)
+    case info
+    when 'filename'
+      result = File.basename(path)
+    when 'basename'
+      result = File.basename(path, extension)
+    when 'extname'
+      result = File.extname(path)
+    when 'parent'
+      result = File.expand_path(File.join(path, '..'))
+    else
+      raise Puppet::ParseError, "staging_parse(), unknown parse info #{info}."
+    end
+    return result
+  end
+end

data/spec/fixtures/modules/staging/manifests/.init.pp.swp ADDED Viewed

Binary file

data/spec/fixtures/modules/staging/manifests/deploy.pp ADDED Viewed

@@ -0,0 +1,42 @@
+# The define resource extracts compressed file to a staging location.
+define staging::deploy (
+  $source,               #: the source file location, supports local files, puppet://, http://, https://, ftp://
+  $target,               #: the target extraction directory
+  $staging_path = undef, #: the staging location for compressed file. defaults to ${staging::path}/${caller_module_name}
+  $username     = undef, #: https or ftp username
+  $certificate  = undef, #: https certifcate file
+  $password     = undef, #: https or ftp user password or https certificate password
+  $environment  = undef, #: environment variable for settings such as http_proxy
+  $timeout      = undef, #: the time to wait for the file transfer to complete
+  $user         = undef, #: extract file as this user
+  $group        = undef, #: extract group as this group
+  $creates      = undef, #: the file/folder created after extraction. if unspecified defaults to ${target}/${name}
+  $unless       = undef, #: alternative way to conditionally extract file
+  $onlyif       = undef  #: alternative way to conditionally extract file
+) {
+  staging::file { $name:
+    source      => $source,
+    target      => $staging_path,
+    username    => $username,
+    certificate => $certificate,
+    password    => $password,
+    environment => $environment,
+    subdir      => $caller_module_name,
+    timeout     => $timeout,
+  }
+  staging::extract { $name:
+    target      => $target,
+    source      => $staging_path,
+    user        => $user,
+    group       => $group,
+    environment => $environment,
+    subdir      => $caller_module_name,
+    creates     => $creates,
+    unless      => $unless,
+    onlyif      => $onlyif,
+    require     => Staging::File[$name],
+  }
+}

data/spec/fixtures/modules/staging/manifests/extract.pp ADDED Viewed

@@ -0,0 +1,109 @@
+# Define resource to extract files from staging directories to target directories.
+define staging::extract (
+  $target,              #: the target extraction directory
+  $source      = undef, #: the source compression file, supports tar, tar.gz, zip, war
+  $creates     = undef, #: the file created after extraction. if unspecified defaults ${staging::path}/${caller_module_name}/${name} ${target}/${name}
+  $unless      = undef, #: alternative way to conditionally check whether to extract file.
+  $onlyif      = undef, #: alternative way to conditionally check whether to extract file.
+  $user        = undef, #: extract file as this user.
+  $group       = undef, #:  extract file as this group.
+  $environment = undef, #: environment variables.
+  $strip       = undef, #: extract file with the --strip=X option. Only works with GNU tar.
+  $subdir      = $caller_module_name #: subdir per module in staging directory.
+) {
+  include staging
+  if $source {
+    $source_path = $source
+  } else {
+    $source_path = "${staging::path}/${subdir}/${name}"
+  }
+  # Use user supplied creates path, set default value if creates, unless or
+  # onlyif is not supplied.
+  if $creates {
+    $creates_path = $creates
+  } elsif ! ($unless or $onlyif) {
+    if $name =~ /.tar.gz$/ {
+      $folder       = staging_parse($name, 'basename', '.tar.gz')
+    } elsif $name =~ /.tar.bz2$/ {
+      $folder       = staging_parse($name, 'basename', '.tar.bz2')
+    } else {
+      $folder       = staging_parse($name, 'basename')
+    }
+    $creates_path = "${target}/${folder}"
+  } else {
+    $creates_path = undef
+  }
+  if scope_defaults('Exec','path') {
+    Exec{
+      cwd         => $target,
+      user        => $user,
+      group       => $group,
+      environment => $environment,
+      creates     => $creates_path,
+      unless      => $unless,
+      onlyif      => $onlyif,
+      logoutput   => on_failure,
+    }
+  } else {
+    Exec{
+      path        => $::path,
+      cwd         => $target,
+      user        => $user,
+      group       => $group,
+      environment => $environment,
+      creates     => $creates_path,
+      unless      => $unless,
+      onlyif      => $onlyif,
+      logoutput   => on_failure,
+    }
+  }
+  if $strip {
+    if $::osfamily == 'Solaris' or $name !~ /(.tar|.tgz|.tar.gz|.tar.bz2)$/ {
+      warning('strip is only supported with GNU tar, ignoring the parameter')
+      $strip_opt = ''
+    } else {
+      $strip_opt = " --strip=${strip}"
+    }
+  } else {
+    $strip_opt = ''
+  }
+  case $name {
+    /.tar$/: {
+      $command = "tar xf ${source_path}${strip_opt}"
+    }
+    /(.tgz|.tar.gz)$/: {
+      if $::osfamily == 'Solaris' {
+        $command = "gunzip -dc < ${source_path} | tar xf - "
+      } else {
+        $command = "tar xzf ${source_path}${strip_opt}"
+      }
+    }
+    /.tar.bz2$/: {
+      $command = "tar xjf ${source_path}${strip_opt}"
+    }
+    /.zip$/: {
+      $command = "unzip ${source_path}"
+    }
+    /(.war|.jar)$/: {
+      $command = "jar xf ${source_path}"
+    }
+    default: {
+      fail("staging::extract: unsupported file format ${name}.")
+    }
+  }
+  exec { "extract ${name}":
+    command => $command,
+  }
+}