gordon 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f6c92da32b5f718a9c6e40061d550a397e44e1d
-  data.tar.gz: 58e7c34da8d28dc869589d2c9b52a19a45e2a95f
+  metadata.gz: b94b6c833eb2861fc1812fd735636616d07f51ac
+  data.tar.gz: b9f06696a7edd532fb343e4c3a184744b6a8ab9e
 SHA512:
-  metadata.gz: c13ff0c341f5787bd0db48d1fc6cf85546efcb06b39334a7e93d5a9af5ec9b8f10c3893846593508c4379673b583b96152f33742d837bef0f1258bfcfbbe8dd3
-  data.tar.gz: a81f165ee34ee5a8bc3595812e94e7f26c5747083ad55c66c59c86b41168e788be10b21f6bc5e169c5df92209ff281c72bb47c4e82ff9cc3b9730a498ea3a9e2
+  metadata.gz: 445412f2ba34785a24825b292811bf835677bfa106f9fa1e97e7e45c0ab4d6a962fa7a2bfe1b8128311dc6de97ac3cf2491c2bcd39eaa83cd18952e87e68288f
+  data.tar.gz: 32a14736b4795a14a46b46d426b8322512f8866cc11d7d74e0a8cd9edbc3c6a7b42e461ae652b96414d5649b0328ad6a97fdb441ff705674fdff41211b91dec8

data/README.md

@@ -22,9 +22,17 @@ Per example: create a user that will run app with credentials, whose $HOME is th
 
 ## How are the options?
 
-* Web Servers: Nginx or Apache (Tomcat soon);
+* Http Servers: Nginx or Apache;
+
+* Web Servers: Tomcat or Jetty;
+
 * Init scripts: Systemd (all generated by Foreman soon);
-* Apps supported: at this time, Ruby Web App. Java soon and others when needed.
+
+* Apps supported:
+
+    * Ruby Web App (resides based on Http Server of choice)
+    * Ruby Standalone App (resides on /opt/*app_name*)
+    * Java Web App (resides based on Web Server of choice)
 
 ## Installation
 
@@ -42,15 +50,21 @@ Or install it yourself as:
 
 ## Usage
 
+First, you need to vendorize all gems in deployment mode:
+
+    $ ruby -S bundle package --all
+
+    $ ruby -S bundle install --deployment --without development test debug
+
 Here a simple example to build a Ruby Web App that runs Nginx and uses Systemd as init process. Just enter on source folder of your app and run in your terminal:
 
     $ ruby -S gordon                     \
       --app-type         ruby_web_app    \
       --app-name         $APP_NAME       \
       --app-desc         $APP_DESC       \
-      --app-repo         $APP_REPO       \
+      --app-home         $APP_HOME       \
       --app-version      $APP_VERSION    \
-      --app-source-dir   .               \
+      --app-source       .               \
       --runtime-version  $MRI_VERSION    \
       --http-server-type nginx           \
       --init-type        systemd         \
@@ -71,7 +85,7 @@ Sounds good?
 
 ## Why you not use Omnibus or Heroku buildpacks?
 
-Because I want to create a tool able to create Linux packages.
+Because I want a tool able to create Linux packages that can be extensible based on my needs.
 
 ## Why you use fpm-cookery templates instead of fpm?
 
@@ -84,8 +98,8 @@ Because I like Gordon Ramsay.
 ## TODO
 
 * Validate outputs
-* Tests
-* Very unstable, need to fix it
+* Refactor to have only one FPM::Cookery recipe.
+* Integrate directly with FPM::Cookery classes
 * Debian check (gem heavly developed under CentOS environment)
 
 ## Contributing
@@ -95,3 +109,4 @@ Because I like Gordon Ramsay.
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+

data/gordon.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 
-  spec.add_dependency "bundler"
   spec.add_dependency "fpm-cookery"
   spec.add_dependency "foreman"
 end

data/lib/gordon/application/templates/java_web_app.rb

@@ -14,12 +14,12 @@ class JavaWebApp < FPM::Cookery::Recipe
           Gordon::Cookery::Java::WebApp
 
   name        $env_vars.app_name
-  description $env_vars.app_desc
+  description $env_vars.app_description
   version     $env_vars.app_version
-  homepage    $env_vars.app_repo
+  homepage    $env_vars.app_homepage
   arch        :noarch
 
-  source      $env_vars.app_source_dir, with: :local_path
+  source      $env_vars.app_source, with: :local_path
 
   depends     *resolve_dependencies($env_vars)
 
@@ -27,7 +27,9 @@ class JavaWebApp < FPM::Cookery::Recipe
   fpm_attributes[:rpm_group]  = 'tomcat'
 
   def build
-    war_path = File.join(get_skeleton_path_from_type($env_vars.web_server_type), $env_vars.app_name)
+    web_server_path = get_skeleton_path_from_type($env_vars, $env_vars.web_server_type)
+
+    war_path = File.join(web_server_path, $env_vars.app_name)
 
     clean_java_web_workdir($env_vars, war_path)
   end

data/lib/gordon/application/templates/ruby_standalone_app.rb

@@ -15,23 +15,21 @@ class RubyStandaloneApp < FPM::Cookery::Recipe
           Gordon::Cookery::Ruby::Common
 
   name        $env_vars.app_name
-  description $env_vars.app_desc
+  description $env_vars.app_description
   version     $env_vars.app_version
-  homepage    $env_vars.app_repo
+  homepage    $env_vars.app_homepage
 
-  source      $env_vars.app_source_dir, with: :local_path
+  source      $env_vars.app_source, with: :local_path
 
   depends     *resolve_dependencies($env_vars)
 
   def build
-    home_path = get_skeleton_path_from_type(:misc)
+    home_path = get_skeleton_path_from_type($env_vars, :misc)
 
     create_user_and_group($env_vars, home_path)
     setup_user_permissions($env_vars, home_path)
 
     create_init($env_vars, :misc)
-
-    ruby_vendor_gems
   end
 
   def install

data/lib/gordon/application/templates/ruby_web_app.rb

@@ -15,23 +15,21 @@ class RubyWebApp < FPM::Cookery::Recipe
           Gordon::Cookery::Ruby::Common
 
   name        $env_vars.app_name
-  description $env_vars.app_desc
+  description $env_vars.app_description
   version     $env_vars.app_version
-  homepage    $env_vars.app_repo
+  homepage    $env_vars.app_homepage
 
-  source      $env_vars.app_source_dir, with: :local_path
+  source      $env_vars.app_source, with: :local_path
 
   depends     *resolve_dependencies($env_vars)
 
   def build
-    home_path = get_skeleton_path_from_type($env_vars.http_server_type)
+    home_path = get_skeleton_path_from_type($env_vars, $env_vars.http_server_type)
 
     create_user_and_group($env_vars, home_path)
     setup_user_permissions($env_vars, home_path)
 
     create_init($env_vars, $env_vars.http_server_type)
-
-    ruby_vendor_gems
   end
 
   def install

data/lib/gordon/application/types.rb

@@ -2,7 +2,7 @@ module Gordon
   module Application
     module Types
       module Base
-        def template_path
+        def get_template_path
           curdir = File.dirname(__FILE__)
           template_path = File.join(curdir, 'templates', "#{get_template}.rb")
 

data/lib/gordon/cli.rb

@@ -4,7 +4,7 @@ module Gordon
   class CLI
     def self.run
       options = Options.new
-      options.app_source_dir = Dir.pwd
+      options.app_source = Dir.pwd
       options.output_dir = Dir.pwd
 
       parser = create_option_parser(options)
@@ -19,28 +19,32 @@ module Gordon
       parser = OptionParser.new do |opts|
         opts.banner = 'Usage: gordon [options]'
 
-        opts.on('-T', '--app-type APP_TYPE', 'Application Type') do |app_type|
-          options.app_type = app_type
-        end
-
         opts.on('-N', '--app-name APP_NAME', 'Application Name') do |app_name|
           options.app_name = app_name
         end
 
-        opts.on('-D', '--app-desc APP_DESC', 'Application Description') do |app_desc|
-          options.app_desc = app_desc
+        opts.on('-D', '--app-description APP_DESCRIPTION', 'Application Description') do |app_description|
+          options.app_description = app_description
         end
 
-        opts.on('-R', '--app-repo APP_REPO', 'Application Repository URL') do |app_repo|
-          options.app_repo = app_repo
+        opts.on('-G', '--app-homepage APP_HOMEPAGE', 'Application Homepage') do |app_homepage|
+          options.app_homepage = app_homepage
         end
 
         opts.on('-V', '--app-version APP_VERSION', 'Application Version') do |app_version|
           options.app_version = app_version
         end
 
-        opts.on('-S', '--app-source-dir APP_SOURCE_DIR', 'Application Source Directory') do |app_source_dir|
-          options.app_source_dir = app_source_dir
+        opts.on('-S', '--app-source APP_SOURCE', 'Application Source') do |app_source|
+          options.app_source = app_source
+        end
+
+        opts.on('-T', '--app-type APP_TYPE', 'Application Type') do |app_type|
+          options.app_type = app_type
+        end
+
+        opts.on('-X', '--runtime-name RUNTIME_NAME', 'Runtime Name') do |runtime_name|
+          options.runtime_name = runtime_name
         end
 
         opts.on('-R', '--runtime-version RUNTIME_VERSION', 'Runtime Version') do |runtime_version|

data/lib/gordon/cooker.rb

@@ -2,7 +2,7 @@ module Gordon
   class Cooker
     attr_reader :recipe, :options
 
-    FPM_COOKERY_COMMAND   = 'ruby -S fpm-cook'
+    FPM_COOKERY_COMMAND   = 'fpm-cook'
     FPM_COOKERY_CACHE_DIR = '/tmp/gordon/cache'
     FPM_COOKERY_BUILD_DIR = '/tmp/gordon/build'
 
@@ -39,10 +39,10 @@ module Gordon
     def get_command_args
       cook_args = []
 
-      cook_args << "--debug"    if options.debug?
+      cook_args << "--debug"    if options.debug
 
       cook_args << "--target #{options.package_type}"
-      cook_args << "--platform #{recipe.platform}" if recipe.requires_platform?
+#     cook_args << "--platform #{recipe.platform}" if recipe.requires_platform?
       cook_args << "--pkg-dir #{File.expand_path(options.output_dir)}"
       cook_args << "--cache-dir #{File.expand_path(FPM_COOKERY_CACHE_DIR)}"
       cook_args << "--tmp-root #{File.expand_path(FPM_COOKERY_BUILD_DIR)}"
@@ -56,7 +56,7 @@ module Gordon
 
       command = "#{env_vars.join " "} #{FPM_COOKERY_COMMAND} #{cook_args.join " "}"
 
-      debug(command) if options.debug?
+      debug(command) if options.debug
 
       Process.run(command)
     end

data/lib/gordon/cookery/application_user.rb

@@ -9,7 +9,7 @@ module Gordon
 set -e
 
 /usr/bin/getent group  #{env_vars.app_name} >/dev/null || /usr/sbin/groupadd --system #{env_vars.app_name};
-/usr/bin/getent passwd #{env_vars.app_name} >/dev/null || /usr/sbin/useradd  --system --gid #{env_vars.app_name} --home-dir #{home_path} --shell /sbin/nologin --comment "#{env_vars.app_desc}" #{env_vars.app_name} >/dev/null || :;
+/usr/bin/getent passwd #{env_vars.app_name} >/dev/null || /usr/sbin/useradd  --system --gid #{env_vars.app_name} --home-dir #{home_path} --shell /sbin/nologin --comment "#{env_vars.app_description}" #{env_vars.app_name} >/dev/null || :;
           __BASH
 
           f.write(bash)

data/lib/gordon/cookery/common.rb

@@ -7,9 +7,14 @@ module Gordon
         base.send(:extend, self)
       end
 
-      def get_skeleton_path_from_type(type)
+      def get_skeleton_path_from_type(env_vars, type)
         skeleton_type = create_skeleton_type(type)
-        skeleton_type.path(skeleton_type.requires_app_name? ? $env_vars.app_name : '')
+        appended_path = skeleton_type.requires_app_name? ? env_vars.app_name : ''
+        skeleton_type.path(appended_path)
+      end
+
+      def create_skeleton_type(type)
+        Skeleton::Factory.create(type)
       end
 
       def all_files_except_blacklisted(*custom_blacklist_files)
@@ -26,10 +31,6 @@ module Gordon
 
         files
       end
-
-      def create_skeleton_type(type)
-        Skeleton::Factory.create(type)
-      end
     end
   end
 end

data/lib/gordon/cookery/dependency_resolver.rb

@@ -1,6 +1,10 @@
+require 'fpm/cookery/facts'
+
 module Gordon
   module Cookery
     module DependencyResolver
+      include Common
+
       def resolve_dependencies(env_vars)
         fragments = env_vars.app_type.split('_')
         app_runtime, app_type = fragments[0], fragments[1]
@@ -23,6 +27,8 @@ module Gordon
 
           runtime_version = "#{runtime_name}#{env_vars.runtime_version}"
         else
+          runtime_name = app_runtime
+
           runtime_version = "#{runtime_name} = #{env_vars.runtime_version}"
         end
 
@@ -42,10 +48,10 @@ module Gordon
       end
 
       def get_os_package_name(env_vars, attribute)
-        package_type = FPM::Cookery::Facts.platform.to_sym
+        platform = FPM::Cookery::Facts.platform.to_sym
 
         skeleton_type = create_skeleton_type(env_vars.send(attribute))
-        os_package_name = skeleton_type.get_os_package_map[package_type]
+        os_package_name = skeleton_type.get_os_package_name(platform)
 
         os_package_name
       end

data/lib/gordon/cookery/http_server.rb

@@ -1,8 +1,10 @@
 module Gordon
   module Cookery
     module HttpServer
+      include Common
+
       def install_http_server_files(env_vars, blacklist)
-        skeleton_path = get_skeleton_path_from_type(env_vars.http_server_type)
+        skeleton_path = get_skeleton_path_from_type(env_vars, env_vars.http_server_type)
 
         application_files = all_files_except_blacklisted(blacklist)
 

data/lib/gordon/cookery/init.rb

@@ -1,11 +1,13 @@
 module Gordon
   module Cookery
     module Init
+      include Common
+
       def create_init(env_vars, skeleton_type)
         init_build_dir_path = builddir(env_vars.init_type)
-        skeleton_path = get_skeleton_path_from_type(skeleton_type)
+        skeleton_path = get_skeleton_path_from_type(env_vars, skeleton_type)
 
-        command = "ruby -S foreman export --procfile Procfile --root #{skeleton_path} --app #{env_vars.app_name} --user #{env_vars.app_name} #{env_vars.init_type} #{init_build_dir_path}"
+        command = "foreman export --procfile Procfile --root #{skeleton_path} --app #{env_vars.app_name} --user #{env_vars.app_name} #{env_vars.init_type} #{init_build_dir_path}"
 
         safesystem(command)
       end
@@ -13,7 +15,7 @@ module Gordon
       def install_init(env_vars)
         init_build_dir_path = builddir(env_vars.init_type)
 
-        skeleton_path = get_skeleton_path_from_type(env_vars.init_type)
+        skeleton_path = get_skeleton_path_from_type(env_vars, env_vars.init_type)
         skeleton_files = Dir["#{init_build_dir_path}/*"]
 
         root(skeleton_path).install skeleton_files

data/lib/gordon/cookery/java/common.rb

@@ -8,4 +8,3 @@ module Gordon
   end
 end
 
-

data/lib/gordon/cookery/ruby/common.rb

@@ -3,14 +3,6 @@ module Gordon
     module Ruby
       module Common
         RUBY_BLACKLIST_FILES = %w(.rspec coverage log spec tmp)
-
-        def ruby_vendor_gems
-          command = 'ruby -S bundle package --all'
-          safesystem(command)
-
-          command = 'ruby -S bundle install --deployment --without development test'
-          safesystem(command)
-        end
       end
     end
   end

data/lib/gordon/cookery/standalone.rb

@@ -1,8 +1,10 @@
 module Gordon
   module Cookery
     module Standalone
+      include Common
+
       def install_standalone_files(env_vars, blacklist)
-        skeleton_path = get_skeleton_path_from_type(:misc)
+        skeleton_path = get_skeleton_path_from_type(env_vars, :misc)
 
         application_files = all_files_except_blacklisted(blacklist)
 

data/lib/gordon/cookery/web_server.rb

@@ -1,8 +1,10 @@
 module Gordon
   module Cookery
     module WebServer
+      include Common
+
       def install_web_server_files(env_vars, blacklist)
-        skeleton_path = get_skeleton_path_from_type(env_vars.web_server_type)
+        skeleton_path = get_skeleton_path_from_type(env_vars, env_vars.web_server_type)
 
         application_files = all_files_except_blacklisted(blacklist)
 

data/lib/gordon/env_vars.rb

@@ -1,7 +1,8 @@
 module Gordon
   class EnvVars
-    attr_accessor :app_type, :app_name, :app_desc, :app_repo, :app_version, :app_source_dir
-    attr_accessor :runtime_version
+    attr_accessor :app_type
+    attr_accessor :app_name, :app_description, :app_homepage, :app_version, :app_source
+    attr_accessor :runtime_name, :runtime_version
     attr_accessor :http_server_type
     attr_accessor :web_server_type
     attr_accessor :init_type
@@ -11,10 +12,11 @@ module Gordon
 
       env_vars << "GORDON_APP_TYPE='#{options.app_type}'"
       env_vars << "GORDON_APP_NAME='#{options.app_name}'"
-      env_vars << "GORDON_APP_DESC='#{options.app_desc}'"
-      env_vars << "GORDON_APP_REPO='#{options.app_repo}'"
+      env_vars << "GORDON_APP_DESCRIPTION='#{options.app_description}'"
+      env_vars << "GORDON_APP_HOMEPAGE='#{options.app_homepage}'"
       env_vars << "GORDON_APP_VERSION='#{options.app_version}'"
-      env_vars << "GORDON_APP_SOURCE_DIR='#{File.expand_path(options.app_source_dir)}'"
+      env_vars << "GORDON_APP_SOURCE='#{File.expand_path(options.app_source)}'"
+      env_vars << "GORDON_RUNTIME_NAME='#{options.runtime_name}'"
       env_vars << "GORDON_RUNTIME_VERSION='#{options.runtime_version}'"
       env_vars << "GORDON_HTTP_SERVER_TYPE='#{options.http_server_type}'"
       env_vars << "GORDON_WEB_SERVER_TYPE='#{options.web_server_type}'"
@@ -28,10 +30,11 @@ module Gordon
 
       env_vars.app_type         = ENV['GORDON_APP_TYPE']
       env_vars.app_name         = ENV['GORDON_APP_NAME']
-      env_vars.app_desc         = ENV['GORDON_APP_DESC']
-      env_vars.app_repo         = ENV['GORDON_APP_REPO']
+      env_vars.app_description  = ENV['GORDON_APP_DESCRIPTION']
+      env_vars.app_homepage     = ENV['GORDON_APP_HOMEPAGE']
       env_vars.app_version      = ENV['GORDON_APP_VERSION']
-      env_vars.app_source_dir   = ENV['GORDON_APP_SOURCE_DIR']
+      env_vars.app_source       = ENV['GORDON_APP_SOURCE']
+      env_vars.runtime_name     = ENV['GORDON_RUNTIME_NAME']
       env_vars.runtime_version  = ENV['GORDON_RUNTIME_VERSION']
       env_vars.http_server_type = ENV['GORDON_HTTP_SERVER_TYPE']
       env_vars.web_server_type  = ENV['GORDON_WEB_SERVER_TYPE']

data/lib/gordon/exceptions.rb

@@ -0,0 +1,10 @@
+module Gordon
+  module Exceptions
+    class OperationalSystemNotMapped < RuntimeError
+      def initialize(class_name, os_name)
+        super("Operational System not mapped for #{class_name}. OS: #{os_name}")
+      end
+    end
+  end
+end
+

data/lib/gordon/options.rb

@@ -1,14 +1,13 @@
 module Gordon
   class Options
-    attr_accessor :app_type, :app_name, :app_desc, :app_repo, :app_version, :app_source_dir
-    attr_accessor :runtime_version
+    attr_accessor :app_name, :app_description, :app_homepage, :app_version, :app_source
+    attr_accessor :app_type
+    attr_accessor :runtime_name, :runtime_version
     attr_accessor :http_server_type
     attr_accessor :web_server_type
     attr_accessor :init_type
     attr_accessor :package_type
     attr_accessor :output_dir
     attr_accessor :debug
-
-    def debug? ; !!debug ; end
   end
 end

data/lib/gordon/process.rb

@@ -2,7 +2,11 @@ module Gordon
   class Process
     def self.run(command)
       pid = ::Process.spawn(command, out: $stdout, err: $stderr)
-      _, status = ::Process.wait2(pid)
+      _, exit_status = ::Process.wait2(pid)
+
+      raise SystemCallError.new("Failed to execute [#{command}]. Exit code: #{exit_status}") unless exit_status == 0
+
+      true
     end
   end
 end

data/lib/gordon/recipe.rb

@@ -21,7 +21,7 @@ module Gordon
     end
 
     def application_template_path
-      application.template_path
+      application.get_template_path
     end
   end
 end

data/lib/gordon/skeleton/types.rb

@@ -6,6 +6,13 @@ module Gordon
           File.join(get_default_path, app.to_s)
         end
 
+        def get_os_package_name(os_name)
+          package = get_os_package_map[os_name]
+          raise Exceptions::OperationalSystemNotMapped.new(self.class.name, os_name) if package.nil?
+
+          package
+        end
+
         def requires_app_name?
           false
         end

data/lib/gordon/version.rb

@@ -1,3 +1,3 @@
 module Gordon
-  VERSION = "0.0.11"
+  VERSION = "0.0.12"
 end

data/lib/gordon.rb

@@ -5,6 +5,7 @@ module Gordon
   require 'gordon/cooker'
   require 'gordon/recipe'
   require 'gordon/env_vars'
+  require 'gordon/exceptions'
   require 'gordon/factory'
   require 'gordon/options'
   require 'gordon/process'

data/spec/gordon/application/types_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Gordon::Application::Types::Base do
+  subject do
+    class MyApplicationTypesBase
+      include Gordon::Application::Types::Base
+
+      def get_template ; 'vudu_eh_pra_jacoo' ; end
+    end
+
+    MyApplicationTypesBase.new
+  end
+
+  it 'returns template path based on class' do
+    path = '/a/strange/path'
+    curdir = File.join(path, 'lib', 'gordon')
+    expect(File).to receive(:dirname).and_return(curdir)
+
+    expected = File.join(curdir, 'templates', 'vudu_eh_pra_jacoo.rb')
+
+    expect(subject.get_template_path).to eq(expected)
+  end
+end
+
+describe Gordon::Application::Types::RubyWebApp do
+  it 'returns a template' do
+    expect(subject.get_template).to eq('ruby_web_app')
+  end
+end
+
+describe Gordon::Application::Types::RubyStandaloneApp do
+  it 'returns a template' do
+    expect(subject.get_template).to eq('ruby_standalone_app')
+  end
+end
+
+describe Gordon::Application::Types::JavaWebApp do
+  it 'returns a template' do
+    expect(subject.get_template).to eq('java_web_app')
+  end
+end
+
+describe Gordon::Application::Types::JavaStandaloneApp do
+  it 'returns a template' do
+    expect(subject.get_template).to eq('java_standalone_app')
+  end
+end
+