soaring 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 471e1eb732ebb5967e82a6be99293fa78bf15254
-  data.tar.gz: 8d69151eb93db088ff40f9f759ddd88b98e5b443
+  metadata.gz: 8a12653a876a7027f53549f4a67afad4fe70ecbc
+  data.tar.gz: 2494d103023713962850494cbc297d3721dcd958
 SHA512:
-  metadata.gz: 2cd69d74a630585aa6a8e43b3fb0ca5cbef0465d61f26988a416d3322c42bb8896f8b42da3ee64d8fc966d9e722e6c47f1c98753b8fbdbbade372c5ad484da18
-  data.tar.gz: c4119109f8e71669a714b46e13892c6147d4273b92f45bac5ff9c43948b17342a3107649a1ce63728c3bdab0d88715e7356658a94f99eec9e562cc1cac987e70
+  metadata.gz: 3903c7eab3cdd2475f9b8cf32b6c57b5dc1a5434e39674c107a7ea635be34040ea5b474e23c2440eb3f630d325bbf3ac574cc12362e32491f4905994c8918614
+  data.tar.gz: e9f941396a3bef6f5edfaed144d2bb5065d8c4729509c903aafd053b38a34347405c5de844fb431e5df60ba03af86e5c20e7fff481ebf4931746c1ee093b5602

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in soar_sc_core.gemspec
+gemspec

data/README.md

@@ -36,7 +36,7 @@ Create an environment.yml file by copying the example and updating to your needs
 
 Start up a local instance of the service component to check that all is well
 ```bash
-  soaring run
+  soaring start
 ```
 
 This will default to a MRI ruby rack application running with the following defaults:
@@ -45,9 +45,14 @@ This will default to a MRI ruby rack application running with the following defa
   environment = 'development'
 ```
 
+To stop you can simply send a CTRL-C or programmatically kill it using the stop command from another terminal
+```bash
+  soaring stop
+```
+
 These defaults can be overriden using parameters passed to soaring. View the command line options:
 ```bash
-  soaring -h
+  soaring help
 ```
 
 ## Packaging the service component for deployment

data/bin/soaring

@@ -4,4 +4,4 @@ bin_file = Pathname.new(__FILE__).realpath
 $:.unshift File.expand_path("../../lib", bin_file)
 
 require 'soaring'
-Soaring::CLI.start(ARGV)
+Soaring::SoaringCLI.start(ARGV)

data/lib/soaring/cli.rb

@@ -1,82 +1,49 @@
-require 'optparse'
+require 'thor'
 
 module Soaring
-  class CLI
-    def self.start(argv)
-      @project_folder = Dir.pwd
-      command, options = self.parse
-      puts "#{command} with #{options}" if options[:verbose]
-      self.send("execute_#{command}",options)
+  class SoaringCLI < Thor
+    desc "init [OPTIONS]", "initialize the folder with soar_sc template"
+    option :verbose,           :aliases => '-v',                            :desc => 'Verbose logging'
+    option :project_root,                        :default => Dir.pwd,       :desc => 'Root folder of the soar project, defaults to current folder'
+    option :soar_sc_refspec,   :aliases => '-r', :default => 'STABLE',      :desc => 'Reference spec (Tag) of soar_sc repo to use for template, defaults to STABLE'
+    def init
+      initializer = Initializer.new(options)
+      initializer.initialize_project
     end
 
-    private
-
-    def self.execute_init(options)
+    desc "update [OPTIONS]", "update the folder with soar_sc template"
+    option :verbose,           :aliases => '-v',                            :desc => 'Verbose logging'
+    option :project_root,                        :default => Dir.pwd,       :desc => 'Root folder of the soar project, defaults to current folder'
+    option :soar_sc_refspec,   :aliases => '-r', :default => 'STABLE',      :desc => 'Reference spec (Tag) of soar_sc repo to use for template, defaults to STABLE'
+    def update
       initializer = Initializer.new(options)
-      initializer.initialize_project(@project_folder)
+      initializer.initialize_project
     end
 
-    def self.execute_run(options)
+    desc "start [OPTIONS]", "start the service component with OPTIONS"
+    option :verbose,           :aliases => '-v',                            :desc => 'Verbose logging'
+    option :project_root,                        :default => Dir.pwd,       :desc => 'Root folder of the soar project, defaults to current folder'
+    option :environment,       :aliases => '-e', :default => 'development', :desc => 'Environment in which to execute [development,production]'
+    option :port,              :aliases => '-p', :default => '9393',        :desc => 'Bind service component server to this port for local run, defaults to 9393'
+    def start
       runner = Runner.new(options)
-      runner.run(@project_folder)
+      runner.run
     end
 
-    def self.execute_package(options)
-      packager = Packager.new(options)
-      packager.package(@project_folder)
+    desc "stop [OPTIONS]", "stop running rackup instances"
+    option :verbose,           :aliases => '-v',                            :desc => 'Verbose logging'
+    option :killsignal,        :aliases => '-k', :default => '9',           :desc => 'The signal to send rackup instances INT signal is graceful, defaults to 9 which is not,'
+    def stop
+      exec("for f in $(ps aux | grep rackup | grep -v grep | tr -s ' ' ' ' | cut -d ' ' -f2); do echo killed $f; kill -#{options[:killsignal]} $f; done")
     end
 
-    def self.parse
-      options = {}
-
-      opt_parser = OptionParser.new do |opt|
-        opt.banner = "Usage: soaring COMMAND [OPTIONS]"
-        opt.separator  ""
-        opt.separator  "Release #{Soaring::VERSION}"
-        opt.separator  ""
-        opt.separator  "Commands"
-        opt.separator  "     init: create/update a new soar service component in the current folder"
-        opt.separator  "     run: run soar service locally"
-        opt.separator  "     package: package the service component for deployment"
-        opt.separator  ""
-        opt.separator  "Options"
-
-        opt.on("-v","--verbose","more verbose output of the process") do
-          options[:verbose] = true
-        end
-
-        opt.on("-e","--environment ENVIRONMENT","environment you want the service to run in") do |environment|
-          options[:environment] = environment
-        end
-
-        opt.on("-p","--port PORT","port to which the service component run must bind to") do |port|
-          options[:port] = port
-        end
-
-        opt.on("-r","--soar_sc_refspec REF_SPEC","git reference spec for the soar_sc to base your init on") do |soar_sc_refspec|
-          options[:soar_sc_refspec] = soar_sc_refspec
-        end
-
-        opt.on("-i","--ignore_git_checks","ignore checks ensuring your repo is up to date") do
-          options[:ignore_git_checks] = true
-          puts "Warning: Ignoring git repo checks"
-        end
-
-        opt.on("-h","--help","help") do
-          puts opt_parser
-          exit 0
-        end
-      end
-      opt_parser.parse!
-
-      command = ARGV[0]
-      valid_commands = ['init', 'run', 'package']
-      if not valid_commands.include?(command)
-        puts 'Invalid command'
-        puts opt_parser
-        exit 1
-      end
-      [command, options]
+    desc "package [OPTIONS]", "package the service component for deployment with OPTIONS"
+    option :verbose,           :aliases => '-v',                            :desc => 'Verbose logging'
+    option :project_root,                        :default => Dir.pwd,       :desc => 'Root folder of the soar project, defaults to current folder'
+    option :ignore_git_checks, :aliases => '-i',                            :desc => 'Ignore git check to ensure local git repo is committed, defaults to false'
+    def package
+      packager = Packager.new(options)
+      packager.package
     end
   end
 end

data/lib/soaring/initializer.rb

@@ -4,25 +4,21 @@ module Soaring
       @options = options
     end
 
-    def initialize_project(project_folder)
-      @project_folder = project_folder
-      git_refspec = 'STABLE' #default to STABLE if not specified
-      git_refspec = @options[:soar_sc_refspec] if @options[:soar_sc_refspec]
-
+    def initialize_project
       Dir.mktmpdir { |dir|
         temporary_folder = dir
         temporary_soar_sc_folder = "#{temporary_folder}/soar_sc"
-        `git --git-dir=/dev/null clone --quiet --progress --branch #{git_refspec} --depth=1 git@gitlab.host-h.net:hetznerZA/soar_sc.git #{temporary_soar_sc_folder}`
+        `git --git-dir=/dev/null clone --quiet --progress --branch #{@options[:soar_sc_refspec]} --depth=1 git@gitlab.host-h.net:hetznerZA/soar_sc.git #{temporary_soar_sc_folder}`
 
-        `yes | cp -rf #{temporary_soar_sc_folder}/config #{@project_folder}`
-        `yes | cp -rf #{temporary_soar_sc_folder}/docker #{@project_folder}`
-        `yes | cp -rf #{temporary_soar_sc_folder}/lib #{@project_folder}`
-        `yes | cp -rf #{temporary_soar_sc_folder}/smaak #{@project_folder}`
-        `yes | cp -rf #{temporary_soar_sc_folder}/config.ru #{@project_folder}`
-        `yes | cp -rf #{temporary_soar_sc_folder}/Gemfile #{@project_folder}`
-        `yes | cp -rf #{temporary_soar_sc_folder}/.ruby-gemset #{@project_folder}`
-        `yes | cp -rf #{temporary_soar_sc_folder}/.ruby-version #{@project_folder}`
-        `yes | cp -rf #{temporary_soar_sc_folder}/.gitignore #{@project_folder}`
+        `yes | cp -rf #{temporary_soar_sc_folder}/config #{@options[:project_root]}`
+        `yes | cp -rf #{temporary_soar_sc_folder}/docker #{@options[:project_root]}`
+        `yes | cp -rf #{temporary_soar_sc_folder}/lib #{@options[:project_root]}`
+        `yes | cp -rf #{temporary_soar_sc_folder}/smaak #{@options[:project_root]}`
+        `yes | cp -rf #{temporary_soar_sc_folder}/config.ru #{@options[:project_root]}`
+        `yes | cp -rf #{temporary_soar_sc_folder}/Gemfile #{@options[:project_root]}`
+        `yes | cp -rf #{temporary_soar_sc_folder}/.ruby-gemset #{@options[:project_root]}`
+        `yes | cp -rf #{temporary_soar_sc_folder}/.ruby-version #{@options[:project_root]}`
+        `yes | cp -rf #{temporary_soar_sc_folder}/.gitignore #{@options[:project_root]}`
       }
     end
   end

data/lib/soaring/packager.rb

@@ -1,15 +1,17 @@
+require 'byebug'
+
 module Soaring
   class Packager
     def initialize(options)
       @options = options
     end
 
-    def package(project_folder)
+    def package
       validate_project if not @options[:ignore_git_checks]
-      build_output_location = generate_build_output_location(project_folder)
+      build_output_location = generate_build_output_location(@options[:project_root])
       update_project_commit_hash
-      `mkdir -p #{project_folder}/build`
-      `zip -r #{build_output_location} * .ebextensions --exclude=build/* --exclude=config/environment.yml`
+      `mkdir -p #{@options[:project_root]}/build`
+      `cd #{@options[:project_root]}; zip -r #{build_output_location} * .ebextensions --exclude=build/* --exclude=config/environment.yml`
       puts "Build packaged at #{build_output_location}"
     end
 
@@ -25,19 +27,31 @@ module Soaring
 
     def generate_build_output_location(project_folder)
       service_name = File.split(project_folder)[-1]
-      revision_hash = `git rev-parse --short HEAD`.chomp
       timestamp = Time.now.strftime("%F-%H%M%S")
-      "#{project_folder}/build/build_#{service_name}_#{revision_hash}_#{timestamp}.zip"
+      "#{project_folder}/build/build_#{service_name}_#{get_short_commit_hash}_#{timestamp}.zip"
     end
 
     def update_project_commit_hash
-      `git rev-parse HEAD > commit-hash`
+      response, exit_status = Executor::execute("cd #{@options[:project_root]}; git rev-parse HEAD > commit-hash")
+      if not exit_status.success?
+        puts 'Failed to package, unable to get commit hash from local git repository'
+        exit 1
+      end
     end
 
     def is_git_repo_up_to_date?
-      git_response = `git status --porcelain`.chomp
-      return true if '' == git_response
+      response, exit_status = Executor::execute("cd #{@options[:project_root]}; git status --porcelain")
+      return true if ('' == response) and (exit_status.success?)
       false
     end
+
+    def get_short_commit_hash
+      response, exit_status = Executor::execute("cd #{@options[:project_root]}; git rev-parse --short HEAD")
+      if not exit_status.success?
+        puts 'Failed to package, unable to get short commit hash from local git repository'
+        exit 1
+      end
+      response.chomp
+    end
   end
 end

data/lib/soaring/runner.rb

@@ -4,16 +4,11 @@ module Soaring
       @options = options
     end
 
-    def run(project_folder)
-      environment = 'development'
-      environment = @options[:environment] if @options[:environment]
-      port = 9393
-      port = @options[:port] if @options[:port]
-
+    def run
       bind_address = '0.0.0.0'
-      rackup_parameters = "-E #{environment} ./config.ru -p #{port} --host #{bind_address}"
+      rackup_parameters = "-E #{@options[:environment]} ./config.ru -p #{@options[:port]} --host #{bind_address}"
       puts "starting rackup with parameters #{rackup_parameters}" if @options[:verbose]
-      `bundle exec rackup #{rackup_parameters}`
+      exec("bundle exec rackup #{rackup_parameters}")
     end
 
   end

data/lib/soaring/tools.rb

@@ -0,0 +1,18 @@
+require 'open3'
+
+module Soaring
+  class Executor
+    def self.execute(command)
+      captured_stdout = ''
+      captured_stderr = ''
+      exit_status = Open3.popen3(ENV, command) {|stdin, stdout, stderr, wait_thr|
+        pid = wait_thr.pid # pid of the started process.
+        stdin.close
+        captured_stdout = stdout.read
+        captured_stderr = stderr.read
+        wait_thr.value # Process::Status object returned.
+      }
+      ["#{captured_stdout}#{captured_stderr}", exit_status]
+    end
+  end
+end

data/lib/soaring/version.rb

@@ -1,3 +1,3 @@
 module Soaring
-  VERSION = "0.1.10"
+  VERSION = "0.1.11"
 end

data/lib/soaring.rb

@@ -1,4 +1,5 @@
 require 'soaring/version'
+require 'soaring/tools'
 require 'soaring/initializer'
 require 'soaring/runner'
 require 'soaring/packager'

data/soaring.gemspec

@@ -24,4 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "byebug", "~> 9"
 
+  spec.add_dependency "thor", "~> 0.19"
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaring
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - Barney de Villiers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-14 00:00:00.000000000 Z
+date: 2016-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '9'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
 description: A collection of command line tools that simplifies the creation, development
   and packaging of a soar project for deployment at Hetzner
 email:
@@ -77,6 +91,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- Gemfile
 - LICENSE.txt
 - README.md
 - bin/soaring
@@ -85,6 +100,7 @@ files:
 - lib/soaring/initializer.rb
 - lib/soaring/packager.rb
 - lib/soaring/runner.rb
+- lib/soaring/tools.rb
 - lib/soaring/version.rb
 - soaring.gemspec
 homepage: https://github.com/hetznerZA/soaring