puppet-module 0.3.0

data/spec/fixtures/releases/jamtur01-apache/Modulefile

@@ -0,0 +1,2 @@
+name 'jamtur01-apache'
+version '0.0.1'

data/spec/fixtures/releases/jamtur01-apache/files/httpd

@@ -0,0 +1,24 @@
+# Configuration file for the httpd service.
+
+#
+# The default processing model (MPM) is the process-based
+# 'prefork' model.  A thread-based model, 'worker', is also
+# available, but does not work with some modules (such as PHP).
+# The service must be stopped before changing this variable.
+#
+#HTTPD=/usr/sbin/httpd.worker
+
+#
+# To pass additional options (for instance, -D definitions) to the
+# httpd binary at startup, set OPTIONS here.
+#
+#OPTIONS=
+#OPTIONS=-DDOWN
+
+#
+# By default, the httpd process is started in the C locale; to 
+# change the locale in which the server runs, the HTTPD_LANG
+# variable can be set.
+#
+#HTTPD_LANG=C
+export SHORTHOST=`hostname -s`

data/spec/fixtures/releases/jamtur01-apache/files/test.vhost

@@ -0,0 +1,18 @@
+#
+# Test vhost
+#
+NameVirtualHost *:80
+<VirtualHost *:80>
+  ServerName testvhost
+  DocumentRoot /tmp/testvhost
+  <Directory /tmp/testvhost> 
+    Options Indexes FollowSymLinks MultiViews
+    AllowOverride None
+    Order allow,deny
+    allow from all
+  </Directory>
+  ErrorLog /var/log/apache2/error.log
+  LogLevel warn
+  CustomLog /var/log/apache2/access.log combined
+  ServerSignature On
+</VirtualHost>

data/spec/fixtures/releases/jamtur01-apache/lib/puppet/provider/a2mod/debian.rb

@@ -0,0 +1,21 @@
+Puppet::Type.type(:a2mod).provide(:debian) do
+    desc "Manage Apache 2 modules on Debian-like OSes (e.g. Ubuntu)"
+ 
+    commands :encmd => "a2enmod"
+    commands :discmd => "a2dismod"
+ 
+    defaultfor :operatingsystem => [:debian, :ubuntu]
+
+    def create
+        encmd resource[:name]
+    end
+ 
+    def destroy
+        discmd resource[:name]
+    end
+ 
+    def exists?
+        mod= "/etc/apache2/mods-enabled/" + resource[:name] + ".load" 
+        File.exists?(mod)
+    end
+end

data/spec/fixtures/releases/jamtur01-apache/lib/puppet/type/a2mod.rb

@@ -0,0 +1,12 @@
+Puppet::Type.newtype(:a2mod) do
+    @doc = "Manage Apache 2 modules"
+ 
+    ensurable
+
+    newparam(:name) do
+       desc "The name of the module to be managed"
+
+       isnamevar
+
+    end 
+end

data/spec/fixtures/releases/jamtur01-apache/manifests/dev.pp

@@ -0,0 +1,5 @@
+class apache::dev {
+  include apache::params
+
+  package{$apache::params::apache_dev: ensure => installed}
+}

data/spec/fixtures/releases/jamtur01-apache/manifests/init.pp

@@ -0,0 +1,34 @@
+# ensure apache is installed
+class apache {
+  include apache::params
+  package{'httpd': 
+    name   => $apache::params::apache_name,
+    ensure => present,
+  }
+  service { 'httpd':
+    name      => $apache::params::apache_name,
+    ensure    => running,
+    enable    => true,
+    subscribe => Package['httpd'],
+  }
+  #
+  # May want to purge all none realize modules using the resources resource type.
+  # A2mod resource type is broken.  Look into fixing it and moving it into apache.
+  #
+  A2mod { require => Package['httpd'], notify => Service['httpd']}
+  @a2mod {
+   'rewrite' : ensure => present;
+   'headers' : ensure => present;
+   'expires' : ensure => present;
+  }
+  $vdir = $operatingsystem? {
+    'ubuntu' => '/etc/apache2/sites-enabled/',
+    default => '/etc/httpd/conf.d',
+  }
+  file { $vdir:
+    ensure => directory,
+    recurse => true,
+    purge => true,
+    notify => Service['httpd'],
+  } 
+}

data/spec/fixtures/releases/jamtur01-apache/manifests/params.pp

@@ -0,0 +1,17 @@
+class apache::params{
+  $user  = 'www-data'
+  $group = 'www-data'
+  
+  case $operatingsystem {
+    "centos": {
+       $apache_name = httpd
+       $ssl_package = mod_ssl
+       $apache_dev  = httpd-devel
+    }
+    "ubuntu": {
+       $apache_name = apache2
+       $ssl_package = apache-ssl
+       $apache_dev  = [ libaprutil1-dev, libapr1-dev, apache2-prefork-dev ]
+    }
+  }
+}

data/spec/fixtures/releases/jamtur01-apache/manifests/php.pp

@@ -0,0 +1,5 @@
+class apache::php{
+  package{'libapache2-mod-php5':
+    ensure => present,
+  }
+}

data/spec/fixtures/releases/jamtur01-apache/manifests/ssl.pp

@@ -0,0 +1,15 @@
+class apache::ssl {
+  include apache
+
+  
+  case $operatingsystem {
+     "centos": {
+        package { $apache::params::ssl_package:
+           require => Package['httpd'],
+        }
+     }
+     "ubuntu": {
+        a2mod { "ssl": ensure => present, }
+     }
+  }
+}

data/spec/fixtures/releases/jamtur01-apache/manifests/vhost.pp

@@ -0,0 +1,15 @@
+define apache::vhost( $port, $docroot, $ssl=true, $template='apache/vhost-default.conf.erb', $priority, $serveraliases = '' ) {
+  include apache
+  $vdir = $operatingsystem? {
+    'ubuntu' => '/etc/apache2/sites-enabled/',
+    default => '/etc/httpd/conf.d',
+  }
+  file{"${vdir}/${priority}-${name}":
+    content => template($template),
+    owner => 'root',
+    group => 'root',
+    mode => '777',
+    require => Package['httpd'],
+    notify => Service['httpd'],
+  }
+}

data/spec/fixtures/releases/jamtur01-apache/metadata.json

@@ -0,0 +1 @@
+{"dependencies":[],"types":[{"providers":[{"name":"a2mod","doc":"Manage Apache 2 modules on Debian and Ubuntu  Required binaries: ``a2enmod``, ``a2dismod``.    Default for ``operatingsystem`` == ``debianubuntu``.  "}],"parameters":[{"name":"name","doc":"The name of the module to be managed"}],"properties":[{"name":"ensure","doc":"The basic property that the resource should be in.  Valid values are ``present``, ``absent``."}],"name":"a2mod","doc":"Manage Apache 2 modules on Debian and Ubuntu"}],"checksums":{"manifests/params.pp":"71734796921dbdbfd58f503622527616","tests/ssl.pp":"191912535199531fd631f911c6329e56","tests/vhost.pp":"1b91e03c8ef89a7ecb6793831ac18399","manifests/php.pp":"b78cc593f1c4cd800c906e0891c9b11f","files/httpd":"295f5e924afe6f752d29327e73fe6d0a","tests/php.pp":"ce7bb9eef69d32b42a32ce32d9653625","lib/puppet/provider/a2mod/a2mod.rb":"18c5bb180b75a2375e95e07f88a94257","files/test.vhost":"0602022c19a7b6b289f218c7b93c1aea","manifests/ssl.pp":"b4334a161a2ba5fa8a62cf7b38f352c8","manifests/dev.pp":"510813942246cc9a7786d8f2d8874a35","manifests/vhost.pp":"cbc4657b0cce5cd432057393d5f6b0c2","tests/init.pp":"4eac4a7ef68499854c54a78879e25535","lib/puppet/type/a2mod.rb":"0e1b4843431413a10320ac1f6a055d15","tests/apache.pp":"4eac4a7ef68499854c54a78879e25535","tests/dev.pp":"4cf15c1fecea3ca86009f182b402c7ab","templates/vhost-default.conf.erb":"9055aed946e1111c30ab81fedac2c8b0","manifests/init.pp":"dc503e26e8021351078813b541c4bd3d","Modulefile":"d43334b4072cd1744121b3b25cd9ed15"},"version":"0.0.1","name":"jamtur01-apache"}

data/spec/fixtures/releases/jamtur01-apache/templates/vhost-default.conf.erb

@@ -0,0 +1,20 @@
+NameVirtualHost *:<%= port %>
+<VirtualHost *:<%= port %>>
+  ServerName <%= name %>
+<%if serveraliases.is_a? Array -%>
+<% serveraliases.each do |name| -%><%= "  ServerAlias #{name}\n" %><% end -%>
+<% elsif serveraliases != '' -%>
+<%= "  ServerAlias #{serveraliases}" -%>
+<% end -%>
+  DocumentRoot <%= docroot %>
+  <Directory <%= docroot %>>
+    Options Indexes FollowSymLinks MultiViews
+    AllowOverride None
+    Order allow,deny
+    allow from all
+  </Directory>
+  ErrorLog /var/log/apache2/<%= name %>_error.log
+  LogLevel warn
+  CustomLog /var/log/apache2/<%= name %>_access.log combined
+  ServerSignature On
+</VirtualHost>

data/spec/fixtures/releases/jamtur01-apache/tests/apache.pp

@@ -0,0 +1 @@
+include apache

data/spec/fixtures/releases/jamtur01-apache/tests/dev.pp

@@ -0,0 +1 @@
+include apache::dev

data/spec/fixtures/releases/jamtur01-apache/tests/init.pp

@@ -0,0 +1 @@
+include apache

data/spec/fixtures/releases/jamtur01-apache/tests/php.pp

@@ -0,0 +1 @@
+include apache::php

data/spec/fixtures/releases/jamtur01-apache/tests/ssl.pp

@@ -0,0 +1 @@
+include apache::ssl

data/spec/fixtures/releases/jamtur01-apache/tests/vhost.pp

@@ -0,0 +1,2 @@
+include apache
+apache::vhost { 'test.vhost': source => 'puppet:///modules/apache/test.vhost' }

data/spec/integration/cli_spec.rb

@@ -0,0 +1,373 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+# Directory that contains sample releases.
+RELEASE_FIXTURES_DIR = File.join(File.dirname(File.expand_path(__FILE__)), "..", "fixtures", "releases")
+
+# Return the pathname string to the directory containing the release fixture called +name+.
+def release_fixture(name)
+  return File.join(RELEASE_FIXTURES_DIR, name)
+end
+
+# Copy the release fixture called +name+ into the current working directory.
+def install_release_fixture(name)
+  release_fixture(name)
+  FileUtils.cp_r(release_fixture(name), name)
+end
+
+describe "cli" do
+  # Return STDOUT and STDERR output generated from +block+ as it's run within a temporary test directory.
+  def run(&block)
+    return output_for do
+      mktestdircd do
+        block.call
+      end
+    end
+  end
+
+  def app
+    return Puppet::Module::Tool::CLI.new
+  end
+
+  before :all do
+    Puppet::Module::Tool.prepare_settings
+
+    @username = "myuser"
+    @module_name  = "mymodule"
+    @full_name = "#{@username}-#{@module_name}"
+    @version = "0.0.1"
+    @release_name = "#{@full_name}-#{@version}"
+  end
+
+  before :each do
+    Puppet::Module::Tool::Cache.clean
+  end
+
+  after :each do
+    Puppet::Module::Tool::Cache.clean
+  end
+
+  describe "version" do
+    it "should display a version" do
+      run do
+        app.version
+      end.should =~ /#{Puppet::Module::Tool.version}/
+    end
+  end
+
+  describe "generate" do
+    it "should generate a module if given a dashed name" do
+      run do
+        app.generate(@full_name)
+
+        File.directory?(@full_name).should == true
+        modulefile = File.join(@full_name, "Modulefile")
+        File.file?(modulefile).should == true
+        metadata = Puppet::Module::Tool::Metadata.new
+        Puppet::Module::Tool::Modulefile.evaluate(metadata, modulefile)
+        metadata.full_name.should == @full_name
+        metadata.username.should == @username
+        metadata.name.should == @module_name
+      end.should =~ /Generating module/
+    end
+
+    it "should fail if given an undashed name" do
+      run do
+        lambda { app.generate("invalid") }.should raise_error(SystemExit)
+      end.should =~ /Could not generate directory "invalid", you must specify a dash-separated username and module name./
+    end
+
+    it "should fail if directory already exists" do
+      run do
+        app.generate(@full_name)
+        lambda { app.generate(@full_name) }.should raise_error(SystemExit)
+      end.should =~ /already exists/
+    end
+  end
+
+  describe "build" do
+    it "should build a module in a directory" do
+      run do
+        app.generate(@full_name)
+        app.build(@full_name)
+
+        File.directory?(File.join(@full_name, "pkg", @release_name)).should == true
+        File.file?(File.join(@full_name, "pkg", @release_name + ".tar.gz")).should == true
+        metadata_file = File.join(@full_name, "pkg", @release_name, "metadata.json")
+        File.file?(metadata_file).should == true
+        metadata = PSON.parse(File.read(metadata_file))
+        metadata["name"].should == @full_name
+        metadata["version"].should == @version
+        metadata["checksums"].should be_a_kind_of(Hash)
+        metadata["dependencies"].should == []
+        metadata["types"].should == []
+      end.should =~ /Building.+Built/m
+    end
+
+    it "should build a module's checksums" do
+      run do
+        app.generate(@full_name)
+        app.build(@full_name)
+
+        metadata_file = File.join(@full_name, "pkg", @release_name, "metadata.json")
+        metadata = PSON.parse(File.read(metadata_file))
+        metadata["checksums"].should be_a_kind_of(Hash)
+
+        modulefile_path = Pathname.new(File.join(@full_name, "Modulefile"))
+        metadata["checksums"]["Modulefile"].should == Digest::MD5.hexdigest(modulefile_path.read)
+      end
+    end
+
+    it "should build a module's types and providers" do
+      run do
+        name = "jamtur01-apache"
+        install_release_fixture name
+        app.build(name)
+
+        metadata_file = File.join(name, "pkg", "#{name}-0.0.1", "metadata.json")
+        metadata = PSON.parse(File.read(metadata_file))
+
+        metadata["types"].size.should == 1
+        type = metadata["types"].first
+        type["name"].should == "a2mod"
+        type["doc"].should == "Manage Apache 2 modules"
+
+
+        type["parameters"].size.should == 1
+        type["parameters"].first.tap do |o|
+          o["name"].should == "name"
+          o["doc"].should == "The name of the module to be managed"
+        end
+
+        type["properties"].size.should == 1
+        type["properties"].first.tap do |o|
+          o["name"].should == "ensure"
+          o["doc"].should =~ /present.+absent/
+        end
+
+        type["providers"].size.should == 1
+        type["providers"].first.tap do |o|
+          o["name"].should == "debian"
+          o["doc"].should =~ /Manage Apache 2 modules on Debian-like OSes/
+        end
+      end
+    end
+
+    it "should build a module's dependencies" do
+      run do
+        app.generate(@full_name)
+        modulefile = File.join(@full_name, "Modulefile")
+
+        dependency1_name = "anotheruser-anothermodule"
+        dependency1_requirement = ">= 1.2.3"
+        dependency2_name = "someuser-somemodule"
+        dependency2_requirement = "4.2"
+        dependency2_repository = "http://some.repo"
+
+        File.open(modulefile, "a") do |handle|
+          handle.puts "dependency '#{dependency1_name}', '#{dependency1_requirement}'"
+          handle.puts "dependency '#{dependency2_name}', '#{dependency2_requirement}', '#{dependency2_repository}'"
+        end
+
+        app.build(@full_name)
+
+        metadata_file = File.join(@full_name, "pkg", "#{@full_name}-#{@version}", "metadata.json")
+        metadata = PSON.parse(File.read(metadata_file))
+
+        metadata['dependencies'].size.should == 2
+        metadata['dependencies'].sort_by{|t| t['name']}.tap do |dependencies|
+          dependencies[0].tap do |dependency1|
+            dependency1['name'].should == dependency1_name
+            dependency1['version_requirement'].should == dependency1_requirement
+            dependency1['repository'].should be_nil
+          end
+          
+          dependencies[1].tap do |dependency2|
+            dependency2['name'].should == dependency2_name
+            dependency2['version_requirement'].should == dependency2_requirement
+            dependency2['repository'].should == dependency2_repository
+          end
+        end
+      end
+    end
+
+
+    it "should rebuild a module in a directory" do
+      run do
+        app.generate(@full_name)
+        app.build(@full_name)
+        app.build(@full_name)
+      end.should =~ /Building.+Built.+Building.+Built/m
+    end
+
+    it "should build a module in the current directory" do
+      run do
+        app.generate(@full_name)
+        Dir.chdir(@full_name)
+        app.build
+
+        File.file?(File.join("pkg", @release_name + ".tar.gz")).should == true
+      end.should =~ /Building.+Built/m
+    end
+
+    it "should fail to build a module without a Modulefile" do
+      run do
+        app.generate(@full_name)
+        FileUtils.rm(File.join(@full_name, "Modulefile"))
+
+        lambda { app.build(@full_name) }.should raise_error(SystemExit)
+      end.should =~ /Could not find a valid module at "#{@full_name}"/
+    end
+
+    it "should fail to build a module directory that doesn't exist" do
+      run do
+        lambda { app.build(@full_name) }.should raise_error(SystemExit)
+      end.should =~ /Could not find a valid module at "#{@full_name}"/
+    end
+
+    it "should fail to build a module in the current directory that's not a module" do
+      run do
+        lambda { app.build }.should raise_error(SystemExit)
+      end.should =~ /Could not find a valid module at current directory/
+    end
+  end
+
+  describe "search" do
+    it "should display matching modules" do
+      run do
+        stub_repository_read 200, <<-HERE
+          [
+            {"full_name": "cli", "version": "1.0"},
+            {"full_name": "web", "version": "2.0"}
+          ]
+        HERE
+        app.search("mymodule")
+      end.should =~ /2 found.+cli.+1\.0.+web.+2\.0/m
+    end
+
+    it "should display no matches" do
+      run do
+        stub_repository_read 200, "[]"
+        app.search("mymodule")
+      end.should =~ /0 found/m
+    end
+
+    it "should fail if can't get a connection" do
+      run do
+        stub_repository_read 500, "OH NOES!!1!"
+        app.search("mymodule")
+      end.should =~ /Could not execute search.+HTTP 500/m
+    end
+  end
+
+  describe "install" do
+    it "should install a module from a filesystem path" do
+      run do
+        app.generate(@full_name)
+        app.build(@full_name)
+
+        FileUtils.mv("#{@full_name}/pkg/#{@release_name}.tar.gz", "#{@release_name}.tar.gz")
+        FileUtils.rm_rf(@full_name)
+
+        app.install("#{@release_name}.tar.gz")
+
+        File.directory?(@full_name).should == true
+        File.file?(File.join(@full_name, 'metadata.json')).should == true
+      end.should =~ /Installed "myuser-mymodule-0.0.1" into directory: myuser-mymodule/
+    end
+
+    it "should install a module from a webserver URL" do
+      run do
+        app.generate(@full_name)
+        app.build(@full_name)
+
+        stub_cache_read File.read("#{@full_name}/pkg/#{@release_name}.tar.gz")
+        FileUtils.rm_rf(@full_name)
+
+        stub_installer_read <<-HERE
+          {"file": "/foo/bar/#{@release_name}.tar.gz", "version": "#{@version}"}
+        HERE
+
+        app.install(@full_name)
+
+        File.directory?(@full_name).should == true
+        File.file?(File.join(@full_name, 'metadata.json')).should == true
+      end.should =~ /Installed #{@release_name.inspect} into directory: #{@full_name}/
+    end
+
+    it "should install a module from a webserver URL using a version requirement" # TODO
+
+    it "should fail if module isn't a slashed name" do
+      run do
+        lambda { app.install("invalid") }.should raise_error(SystemExit)
+      end.should =~ /Could not install module with invalid name/
+    end
+
+    it "should fail if module doesn't exist on webserver" do
+      run do
+        stub_installer_read "{}"
+        lambda { app.install("not-found") }.should raise_error(SystemExit)
+      end
+    end
+
+    it "should fail gracefully when receiving invalid PSON" do
+      pending "Implement PSON error wrapper" # TODO
+      run do
+        stub_installer_read "1/0"
+        lambda { app.install("not-found") }.should raise_error(SystemExit)
+      end
+    end
+
+    it "should fail if installing a module that's already installed" do
+      run do
+        name = "myuser-mymodule"
+        Dir.mkdir name
+        lambda { app.install(name) }.should raise_error(SystemExit)
+      end.should =~ /already installed/
+    end
+
+  end
+
+  describe "clean" do
+    it "should clean cache" do
+      run do
+        app.generate(@full_name)
+        app.build(@full_name)
+        FileUtils.mv("#{@full_name}/pkg/#{@release_name}.tar.gz", "#{@release_name}.tar.gz")
+        FileUtils.rm_rf(@full_name)
+        app.install("#{@release_name}.tar.gz")
+
+        Puppet::Module::Tool::Cache.base_path.directory?.should == true
+
+        app.clean
+
+        Puppet::Module::Tool::Cache.base_path.directory?.should == false
+      end
+    end
+  end
+
+  describe "changes" do
+    it "should display changes" do
+      run do
+        app.generate(@full_name)
+        app.build(@full_name)
+        Dir.chdir("#{@full_name}/pkg/#{@release_name}")
+        File.open("Modulefile", "a") do |handle|
+          handle.puts
+          handle.puts "# Added"
+        end
+        puts "CHANGES:"
+        app.changes(".")
+      end.should =~ /CHANGES:.+Modulefile\s*\z/m
+    end
+  end
+
+  describe "repository" do
+    it "should display repository" do
+      run do
+        # TODO How to avoid accessing "~/.puppet/puppet.conf" without stubbing parts we want to exercise?
+        app.repository
+      end.should =~ %r{http://}
+    end
+  end
+
+end