cany 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 259ed776e530912657f05fd1f8ec41ef3de1d667
-  data.tar.gz: 6c9441bcd31cec929af0d129206495cb54ab5f34
+  metadata.gz: 689bd4e09a4407570532a6ec0679c9d75c67f020
+  data.tar.gz: fda3db01834b24bb64435e07f1c12cd37463e551
 SHA512:
-  metadata.gz: 28292d32841cc8e2842207dfb71d9d0b90cf8367ab42f1fb8d6adc85dd398527a9b2d8bf5183b367d48c906d6e9d24eb6e497ceaa56d9d3e37e9aeaf405bac7b
-  data.tar.gz: 68462bee6203f87debebae7d4e9dbbcef6f6aa858da5904ed51502852ff596b7d5cb15d927cfb8b1f36be61bfbf907e7c696068722e30f60f530ba04733965c3
+  metadata.gz: be07431ce48ede3893ebb6b3cfcbdd45ac97313cc8239852239a9560bc054e42c7cb468193678a656e7735a7523b95b7ffeb4d4ee855b1e6707c8c04ccdf35d0
+  data.tar.gz: da2e5f74092021b94313860e4bf32ad9142b5fd16fea636e07563c3e6d8633bbe4776c16c21465b5b27bacd7af064ca14ba5014f85bd9f66d16c62179f9c5f5d

data/CHANGELOG.md

@@ -0,0 +1,38 @@
+0.1.0 / 2013-09-23
+==================
+
+Features:
+
+  + Support recipe hooks
+  + Support recipe (configuration) option
+  + Rewritten and extended dependency management
+  + Support (source) package generation adjustments by recipes
+  + canspec: new require_cany directive
+  + Support per rails configuration
+  + Refactored init script management (supports multiple services per package)
+  + sidekiq recipe
+  + unicorn recipe
+
+Bug fixes:
+
+  * rails: export RAILS_ENV in wrapper script
+  * bundler: add some more gem dependencies
+  * recipe: exit on failed command (like bundle install)
+  * dpkg: create compat 9 packages
+
+
+0.0.2 / 2013-09-13
+==================
+
+Bug fixes:
+
+  * rails: run asset compilation inside assets environment
+  * dpkg: replace hard coded package name
+  * rails: run rake inside bundle
+  * recipe: use same ruby intepreter as for cany
+
+
+0.0.1 / 2013-09-12
+==================
+
+  * Basic support to pack a rails application

data/Gemfile

@@ -3,6 +3,18 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in cany.gemspec
 gemspec
 
+group :development do
+  gem 'yard', '~> 0.8.6'
+  gem 'guard'
+  gem 'libnotify', :require => false
+  gem 'rb-inotify', :require => false
+  gem 'rb-fsevent', :require => false
+  gem 'rb-fchange', :require => false
+  gem 'guard-rspec'
+  gem 'guard-yard'
+  gem 'redcarpet', platform: :ruby
+end
+
 group :test do
   gem 'deb_control', '~> 0.0.1'
   gem 'coveralls', require: false

data/Guardfile

@@ -0,0 +1,20 @@
+#
+# Guardfile -- for RSpec
+#
+
+guard 'rspec', all_after_pass: true, all_on_start: true do
+  watch(%r{^spec/(.+)_spec\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('spec/spec_helper.rb')                        { "spec" }
+end
+
+guard 'yard' do
+  watch(%r{lib/.+\.rb})
+end
+
+# load Guardfile.local
+local_guardfile = File.dirname(__FILE__) + "/Guardfile.local"
+if File.file?(local_guardfile)
+  self.instance_eval(Bundler.read_file(local_guardfile))
+end

data/Rakefile

@@ -3,3 +3,14 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 task default: :spec
+
+begin
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+
+  YARD::Rake::YardocTask.new do |t|
+    t.files = %w(lib/**/*.rb)
+    t.options = %w(--output-dir doc/)
+  end
+rescue LoadError
+end

data/lib/cany.rb

@@ -1,29 +1,98 @@
-require 'cany/version'
-require 'cany/specification'
-require 'cany/recipe'
-require 'cany/recipes/bundler'
-require 'cany/recipes/rails'
-require 'cany/recipes/web_server'
-require 'cany/recipes/thin'
-require 'cany/dpkg'
-require 'cany/dpkg/creator'
-require 'cany/dpkg/builder'
-require 'cany/dpkg/deb_helper_recipe'
+require 'logger'
 
 module Cany
-  class MissingSpecification < Exception
-  end
-
-  class MultipleSpecifications < Exception
-  end
-
+  # @raise [MissingSpecification] if no canspec is found in the directory
+  # @raise [MultipleSpecifications] if multiple canspec files are found inside
+  #   the directory
   def self.setup(directory='.')
     specs = Dir[directory + '/*.' + Specification::EXT]
-    raise MissingSpecification, "No #{Specification::EXT} found in #{directory}" if specs.size == 0
-    raise MultipleSpecifications, "Multiple #{Specification::EXT} found in #{directory}" if specs.size > 1
+    raise MissingSpecification.new(directory) if specs.size == 0
+    raise MultipleSpecifications.new(directory) if specs.size > 1
     file = specs.first
     spec = eval File::read(file), binding, file
     spec.base_dir = directory
     spec
   end
+
+  # This methods creates a hash that returns an array as default value and also
+  # stores it directly inside the hash, so that the return value can be changed
+  # without additional actions.
+  # @example
+  #   hash = hash_with_array_as_default
+  #   hash[:hans] << 'otto'
+  #   hash[:hash] == ['otto']
+  def self.hash_with_array_as_default
+    {}.tap do |hash|
+      hash.default_proc = Proc.new do |_, key|
+        hash[key] = []
+      end
+    end
+  end
+
+  # @api public
+  # @return [Logger]
+  def self.logger
+    @logger ||= create_logger
+  end
+
+  def self.create_logger
+    logger = Logger.new(STDOUT)
+    logger.level = Logger::INFO
+    org_formatter = Logger::Formatter.new
+    logger.formatter = proc do |severity, datetime, progname, msg|
+      if severity == "INFO"
+        "   #{msg}\n"
+      else
+        org_formatter.call severity, datetime, progname, msg
+      end
+    end
+    logger
+  end
+
+  require 'cany/version'
+  require 'cany/errors'
+  # This module contains ruby mixins that are used within multiple classes to share code.
+  module Mixins
+    require 'cany/mixins/depend_mixin'
+  end
+  require 'cany/dependency'
+  require 'cany/specification'
+  require 'cany/recipe'
+
+
+  # Applications using common libraries to concentrate on things that are new
+  # and no solved by existing software. Therefore there are similar deploy
+  # tasks that are needed for applications.
+  #
+  # Cany groups common deploy aspects in recipes. This recipes can be included
+  # and used by the application. Normally there exists one recipe for every
+  # important software that is used by the application and influences directly
+  # the way the applications needs to be installed.
+  #
+  # Central recipes are bundler as gem package manager and rails as popular
+  # web framework.
+  #
+  # To support starting the applications there is also a collection of recipes
+  # deploying ruby web server or background services.
+  module Recipes
+    require 'cany/recipes/bundler'
+    require 'cany/recipes/bundler/gem'
+    require 'cany/recipes/bundler/gem_db'
+    require 'cany/recipes/rails'
+    require 'cany/recipes/web_server'
+    require 'cany/recipes/thin'
+    require 'cany/recipes/unicorn'
+    require 'cany/recipes/sidekiq'
+  end
+
+
+  # Cany is designed to be able to pack applications for multiple package
+  # managers. Although there is currently only support for debian/ubuntu.
+  # All DPKG specific things are group into the Dpkg namespace.
+  module Dpkg
+    require 'cany/dpkg'
+    require 'cany/dpkg/creator'
+    require 'cany/dpkg/builder'
+    require 'cany/dpkg/deb_helper_recipe'
+  end
 end

data/lib/cany/dependency.rb

@@ -0,0 +1,70 @@
+module Cany
+  # This class representing a dependency on an abstract object like a gem or a external software.
+  #
+  # Depending on the platform different packages are needed to satisfy the dependency. This class
+  # stores which packages (and optional a version constraint) is needed for every platform,
+  # distribution or distribution release.
+  #
+  # This class differs between two different situation where dependencies are needed: to build
+  # the package (:build) or to run/use the packages (:runtime).
+  #
+  # A dependency has also a priority:
+  #   - :required: The dependency have to be fulfilled in every situation otherwise it is not
+  #     possible to build or run the application.
+  # Other priorities are planed but currently not implemented.
+  class Dependency
+    def initialize(opts={})
+      opts = { situations: [:runtime] }.merge opts
+      @default = []
+      @distros = Cany.hash_with_array_as_default
+      @distro_releases ||= Cany.hash_with_array_as_default
+      self.situations = opts[:situations]
+    end
+
+    attr_reader :situations
+    def situations=(value)
+      @situations = value.kind_of?(Array) ? value : [value]
+    end
+    def runtime?; @situations.include? :runtime; end
+    def build?; @situations.include? :build; end
+
+    # Define the default package name and an optional version constraint for all
+    # @param name[String] A package name
+    # @param version[String, nil] A version constraint
+    def define_default(name, version=nil)
+      default << [name, version]
+    end
+
+    # Define the default package name and an optional version constraint for a distribution
+    # @param distro[Symbol] The distribution name like :ubuntu, :debian ...
+    # @param name[String] A package name
+    # @param version[String, nil] A version constraint
+    def define_on_distro(distro, name, version=nil)
+      distros[distro] << [name, version]
+    end
+
+    # Define the package name and an optional version constraint for a distribution release
+    # @param distro[Symbol] The distribution name like :ubuntu, :debian ...
+    # @param release[Symbol] The distribution release like :precise for ubuntu 12.04
+    # @param name[String] A package name
+    # @param version[String, nil] A version constraint
+    def define_on_distro_release(distro, release, name, version=nil)
+      distro_releases[[distro, release]] << [name, version]
+    end
+
+    # Evaluation which packages (with version constraint) are needed for the given distrobution
+    # release.
+    # @param distro[Symbol] The distribution name like :ubuntu, :debian ...
+    # @param release[Symbol] The distribution release like :precise for ubuntu 12.04
+    # @return [Array<String, String>]
+    def determine(distro, release)
+      return distro_releases[[distro, release]] if distro_releases.has_key? [distro, release]
+      return distros[distro] if distros.has_key? distro
+      default
+    end
+
+    protected
+
+    attr_reader :default, :distros, :distro_releases
+  end
+end

data/lib/cany/dpkg/builder.rb

@@ -11,26 +11,14 @@ module Cany
         @spec = spec
       end
 
-      def debian(*args)
-        File.join spec.base_dir, 'debian', *args
-      end
-
       # This method is called to do the actual work
       # @api public
       # @param [String] build_step_name The name of the dpkg build step (clean, build, binary)
       def run(build_step_name)
-        setup_recipes
-        @recipes.first.send build_step_name.to_s
-      end
-
-      # @api private
-      # This method creates recipe instances for all required recipes from the given spec.
-      def setup_recipes
-        @recipes = []
-        @recipes << DebHelperRecipe.new(spec, nil)
-        spec.recipes.reverse.each do |name|
-          @recipes.unshift Recipe.from_name(name).new(spec, @recipes.first)
-        end
+        spec.system_recipe = DebHelperRecipe.new spec
+        spec.setup_recipes
+        spec.system_recipe.exec 'dh_prep' if build_step_name.to_s == 'binary'
+        spec.recipes.first.send build_step_name.to_s
       end
     end
   end

data/lib/cany/dpkg/creator.rb

@@ -48,6 +48,12 @@ module Cany
       def run(*args)
         parse_opts *args
 
+        # let recipes influence package creating
+        @spec.system_recipe = DebHelperRecipe.new(spec)
+        @spec.recipes.each do |recipe|
+          recipe.create(self)
+        end
+
         Dir.mkdir debian
         create_compact
         create_source_format
@@ -64,29 +70,11 @@ module Cany
 
       def create_compact
         File.open debian('compat'), 'w' do |f|
-          f.write '8'
+          f.write '9'
         end
       end
 
       def create_source_control
-        require 'bundler'
-        lock_path = File.join(spec.base_dir, 'Gemfile.lock')
-        extra_libs = {
-            pg: ['libpq-dev', 'libpq5'],
-            ethon: ['libcurl3 | libcurl3-gnutls | libcurl3-nss', 'libcurl3 | libcurl3-gnutls | libcurl3-nss']
-        }
-        src_deps = ['debhelper (>= 7.0.50~)', ruby_deb, ruby_deb + '-dev']
-        bin_deps = ['${shlibs:Depends}', '${misc:Depends}', ruby_deb]
-        if File.exists? lock_path
-          lock = Bundler::LockfileParser.new File.read lock_path
-          lock.specs.each do |spec|
-            if extra_libs.has_key? spec.name.to_sym
-              src, bin = extra_libs[spec.name.to_sym]
-              src_deps << src
-              bin_deps << bin
-            end
-          end
-        end
         File.open debian('control'), 'w' do |f|
           # write source package fields:
           f.write("Source: #{spec.name}\n")
@@ -95,13 +83,13 @@ module Cany
           f.write("Maintainer: #{spec.maintainer_name} <#{spec.maintainer_email}>\n")
           f.write("Standards-Version: 3.9.2\n")
           f.write("Homepage: #{spec.website}\n")
-          f.write("Build-Depends: #{src_deps.join(', ')}\n")
+          f.write("Build-Depends: #{resolve_dependencies(@spec.build_dependencies)}\n")
 
           # write binary package fields:
           f.write("\n")
           f.write("Package: #{spec.name}\n")
           f.write("Architecture: any\n")
-          f.write("Depends: #{bin_deps.join(', ')}\n")
+          f.write("Depends: #{resolve_dependencies(@spec.runtime_dependencies)}\n")
           f.write("Description: #{spec.description}\n")
         end
       end
@@ -119,14 +107,22 @@ module Cany
 
       def create_rules
         File.open debian('rules'), 'w' do |f|
-          f.write("#!/usr/bin/make -f\n")
-          f.write("export PATH := debian/bin:${PATH}\n")
-          f.write("export GEM_PATH := debian/gems:${GEM_PATH}\n")
-          # call cany for every target:
-          f.write("%:\n")
-          f.write("\t#{ruby_exe} -cS cany >/dev/null || #{ruby_exe} -S gem install --no-ri --no-rdoc --install-dir debian/gems --bindir debian/bin $${CANY_GEM:-cany}\n")
-          f.write("\t#{ruby_exe} -S cany dpkg-builder $@\n")
-          f.write("\noverride_dh_prep:\n")
+          unless @spec.cany_version_constraint
+            gem_version = ''
+          else
+            gem_version = " --version \"#{@spec.cany_version_constraint}\""
+            gem_version += ' --prerelease' if @spec.cany_version_constraint.match /[a-zA-Z]/
+          end
+
+          f.write <<EOM.gsub /^            /, ''
+            #!/usr/bin/make -f
+            export PATH := debian/bin:${PATH}
+            export GEM_PATH := debian/gems:${GEM_PATH}
+            %:
+            \t#{ruby_exe} -cS cany >/dev/null || #{ruby_exe} -S gem install --no-ri --no-rdoc --install-dir debian/gems --bindir debian/bin $${CANY_GEM:-cany}#{gem_version}
+            \t#{ruby_exe} -S cany dpkg-builder $@\n
+            override_dh_prep:
+EOM
 
           f.chmod(0755)
         end
@@ -141,6 +137,20 @@ module Cany
           f.write " -- #{spec.maintainer_name} <#{spec.maintainer_email}>  #{Time.now.strftime "%a, %d %b %Y %H:%M:%S %z" }"
         end
       end
+
+      private
+
+      # Converts the given array of dependencies objects into a dependency string used inside
+      # debians source control files
+      # @param dependencies[Array<Dependency>]
+      # @return [String] A dependency string
+      def resolve_dependencies(dependencies)
+        dependencies.inject([]) do |deps, dep|
+          deps + dep.determine(:ubuntu, :precise).map do |pkg, version|
+            !version.nil? ? "#{pkg} (#{version})" : pkg
+          end
+        end.join(', ')
+      end
     end
   end
 end

data/lib/cany/dpkg/deb_helper_recipe.rb

@@ -1,28 +1,113 @@
-module Cany
-  module Dpkg
-    class DebHelperRecipe < Cany::Recipe
-      register_as :deb_helper
-
-      def initialize(*args)
-        super *args
-        @log = File.read('debian/xikolo-account.debhelper.log') if File.exists?  'debian/xikolo-account.debhelper.log'
-        exec 'dh_prep'
-      end
+require 'erb'
 
-      def clean
-        exec %w(dh clean)
-      end
+module Cany::Dpkg
+  class DebHelperRecipe < Cany::Recipe
+    register_as :deb_helper
+
+    option :service_pre_scripts
+
+    def initialize(*args)
+      super *args
+      @services = {}
+      @pre_scripts = []
+      @log = File.read debhelper_log if File.exists? debhelper_log
+    end
+
+    def create(creator)
+      depend 'debhelper', version: '>= 7.0.50~', situation: :build
+      depend '${shlibs:Depends}'
+      depend '${misc:Depends}'
+      depend creator.ruby_deb, situation: [:build, :runtime]
+      depend creator.ruby_deb + '-dev', situation: :build
+    end
+
+    def clean
+      exec %w(dh clean)
+    end
+
+    def build
+      instance_eval &spec.build if spec.build
+      exec %w(dh build)
+    end
+
+    def binary
+      instance_eval &spec.binary if spec.binary
+      install_base_service
+      install_services
+      File.write debhelper_log, @log if File.exists? debhelper_log
+      exec %w(dh binary)
+    end
+
+    def install_service(name, command, opts={})
+      opts = {user: 'root', group: 'root'}.merge opts
+      opts[:command] = command
+      @services[name] = opts
+    end
+
+    def install_services
+      @services.each do |name, opts|
+        File.write debian("#{spec.name}.#{spec.name}-#{name}.upstart"), render(<<-EOF.gsub(/^ {10}/, ''), opts.merge(name: name))
+          description "<%= spec.description %> - <%= name %>"
 
-      def build
-        instance_eval &spec.build if spec.build
-        exec %w(dh build)
+          start on started <%= spec.name %>
+          stop on stopping <%= spec.name %>
+
+          respawn
+          respawn limit 10 5
+          umask 022
+
+          chdir /usr/share/<%= spec.name %>
+
+          <% if user %>
+          setuid <%= user %>
+          <% end %>
+          <% if group %>
+          setgid <%= group %>
+          <% end %>
+
+          exec <%= command.join(' ') %>
+        EOF
+        exec %w{dh_installinit --name}, "#{spec.name}-#{name}"
       end
+    end
+
+    def install_base_service
+      File.write debian("#{spec.name}.upstart"), render(<<-EOF.gsub(/^ {8}/, ''))
+        description "#{spec.description}"
+
+        start on filesystem or runlevel [2345]
+        stop on runlevel [!2345]
+
+        respawn
+        respawn limit 10 5
+        umask 022
 
-      def binary
-        instance_eval &spec.binary if spec.binary
-        File.write("debian/#{spec.name}.debhelper.log", @log)
-        exec %w(dh binary)
+        pre-start script
+        <% pre_scripts.each do |k, command| %>
+          <%= command %>
+        <% end %>
+        end script
+
+        exec sleep 1d
+      EOF
+    end
+
+    private
+    def render(template, opts={})
+      def opts.method_missing(name)
+        self[name]
       end
+      opts[:spec] = spec
+      opts[:pre_scripts] = option :service_pre_scripts
+      ERB.new(template, nil, '<>').result opts.instance_eval { binding }
+    end
+
+    def debian(*args)
+      File.join('debian', *args)
+    end
+
+    def debhelper_log
+      debian("#{spec.name}.debhelper.log")
     end
   end
 end