gorgon 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2697c5404498b1f1605746aa77f4812b3c106538
-  data.tar.gz: 8785ea9e49a5994a35e83f08b65106cfbc9369a4
+  metadata.gz: eef07ed03530c2480e46991f18ffaedcb485dd2e
+  data.tar.gz: 69d4d71b43c58958eafbb489e9fea40aac62eea1
 SHA512:
-  metadata.gz: b407fe9b9ccff0e2f6eefe038dff6bae1b71ab323622621fa98dbff3b92bb5ac55188990fdd7182b01349e7f6c13136f2c6b3ec1bdd1a76ddf214d0bce362361
-  data.tar.gz: e2846f05b7d0cd1213261356973a756dc75ee507a9c24e80e67bcbf3e22687ab59c15e8dd0449a07dcc9b27c3a9e3a8d319d7874cb54a33650adf94afe9c6144
+  metadata.gz: e546e88bc56e0e7d91a87691246d0ba555fdacb344f0cc832c968ce0f07599db929123061da6b6608f3d27cf7d754c82655153a193a0b9e0ca226d632841d397
+  data.tar.gz: fc1d646ada5533fdd070a7cdaeabdf61a3219f8edca3150fe69aabe62afebbea33c257515692bb1847133f6a1f9ecd470b0388b80554621cb05571d6ec831705

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gorgon (0.8.0)
+    gorgon (0.8.1)
       amqp (~> 1.1.0)
       awesome_print
       colorize (~> 0.5.8)

data/README.md

@@ -26,14 +26,10 @@ Gotchas
 
 Also note that the steps in the tutorial are **not** meant to work on every project, they will only give you initial settings. You will probably have to modify the following files:
 * gorgon.json
-* test/gorgon_callbacks/after\_sync.rb
-* test/gorgon_callbacks/before\_creating\_workers.rb
-* test/gorgon_callbacks/after\_creating\_workers.rb
-* test/gorgon_callbacks/before\_start.rb
-* test/gorgon_callbacks/after\_complete.rb
-* ~/.gorgon/gorgon_listener.json
+* {test, spec}/gorgon_callbacks/gorgon_callbacks.rb
+* gorgon_listener.json (located in your project root or in ~/.gorgon/)
 
-If you modify ~/.gorgon/gorgon_listener.json, make sure you restart the listener by running `sudo restart gorgon`
+If you modify ~/.gorgon/gorgon_listener.json, make sure you restart the listener.
 
 Configuration
 ---------------------
@@ -42,13 +38,14 @@ Configuration
 This file contains project-specific settings for gorgon, such as:
 
 * The connection information for AMQP
-* Information about how clients can rsync the working directory (optional)
+* The connection information for File Server
+* Information about how clients can rsync the working directory (optional). See more info [here](/rsync_transport.md) 
 * Files that can be excluded by rsync
-* Files containing Ruby code to be used as callbacks
+* Callback file containing Ruby code to be used as callbacks
 * A glob for generating the list of test files
 * The file used for Originator's logs
 
-See [gorgon.json example](/gorgon.json.sample) for more details.
+See [gorgon.json example](/gorgon.json.sample) for an example file.
 
 ### gorgon_listener.json
 This file contains the listener-specific settings, such as:

data/daemon_with_upstart_and_rvm.md

@@ -11,4 +11,6 @@ These steps will guarantee that the listener is always running and it will start
 1. ``rvmsudo foreman export upstart /etc/init -a gorgon -u `whoami` -c listener=1``
 1. `sudo start gorgon`
 1. open ’/etc/init/gorgon.conf’ and add `start on runlevel [2345]` at the top of the file
-1. Check if listener is running: Run `tail /tmp/gorgon-remote.log` and the last line should say “Waiting for jobs…”
+1. Check if listener is running: Run `tail /tmp/gorgon-remote.log` and the last line should say “Waiting for jobs…”
+
+If you modify ~/.gorgon/gorgon_listener.json, make sure you restart the listener by running `sudo restart gorgon`

data/lib/gorgon/settings/files_content.rb

@@ -1,7 +1,7 @@
 module Settings
   class FilesContent
     attr_accessor :amqp_host, :file_server_host, :sync_exclude, :files, :originator_log_file,
-      :callbacks, :callbacks_dir
+      :callbacks
 
     TEST_UNIT_GLOB = "test/**/*_test.rb"
     RSPEC_GLOB = "spec/**/*_spec.rb"

data/lib/gorgon/settings/initial_files_creator.rb

@@ -25,7 +25,7 @@ module Settings
 
     def self.create_gorgon_json content
       if File.exist? GORGON_JSON_FILE
-        puts "gorgo.json exists. Skipping..."
+        puts "#{GORGON_JSON_FILE} exists. Skipping..."
         return
       end
 
@@ -34,8 +34,8 @@ module Settings
         file_server: {host: content.file_server_host},
         job: {
           sync: {
-            exclude: content.sync_exclude
-            # TODO: add rsync_transport config
+            exclude: content.sync_exclude,
+            rsync_transport: "ssh"
           }
         },
         files: content.files
@@ -45,12 +45,11 @@ module Settings
       config[:originator_log_file] = log_file if log_file
 
       if content.callbacks
-        create_callback_files(content)
+        create_callback_file(content)
 
-        config[:job][:callbacks] = content.callbacks.inject({}) do |callbacks, e|
-          callbacks[e[:name]] = "#{content.callbacks_dir}/#{e[:file_name]}"
-          callbacks
-        end
+        config[:job][:callbacks] = {
+          callbacks_class_file: content.callbacks[:file_name]
+        }
       end
 
       puts "Creating #{GORGON_JSON_FILE}..."
@@ -59,23 +58,17 @@ module Settings
       end
     end
 
-    def self.create_callback_files content
-      FileUtils.mkdir_p content.callbacks_dir
-      content.callbacks.each do |callback|
-        create_callback_file content.callbacks_dir, callback
-      end
-    end
-
-    def self.create_callback_file dir, callback
-      file_path = "#{dir}/#{callback[:file_name]}"
+    def self.create_callback_file(content)
+      file_path = content.callbacks[:file_name]
       if File.exist? file_path
         puts "#{file_path} already exists. Skipping..."
         return
       end
 
       puts "Creating #{file_path}..."
+      FileUtils.mkdir_p(File.dirname(file_path))
       File.open(file_path, 'w') do |f|
-        f.write callback[:content]
+        f.write content.callbacks[:file_content]
       end
     end
   end

data/lib/gorgon/settings/rails_project_files_content.rb

@@ -14,95 +14,89 @@ module Settings
     private
 
     def create_callbacks
-      @callbacks_dir = "#{get_app_subdir}gorgon_callbacks"
-      @callbacks = [{name: :after_sync, file_name: "after_sync.rb",
-                      content: after_sync_content},
-                    {name: :before_creating_workers, file_name: "before_creating_workers.rb",
-                      content: before_creating_workers_content},
-                    {name: :after_creating_workers, file_name: "after_creating_workers.rb",
-                      content: after_creating_workers_content},
-                    {name: :before_start, file_name: "before_start.rb",
-                      content: before_start_content}]
+      @callbacks = {
+        file_name: "#{get_app_subdir}/gorgon_callbacks/gorgon_callbacks.rb",
+        file_content: callback_file_content
+      }
     end
 
     def get_app_subdir
       if Dir.exist? "test"
-        "test/"
+        "test"
       elsif Dir.exist? "spec"
-        "spec/"
+        "spec"
       elsif Dir.exist? "lib"
-        "lib/"
+        "lib"
       else
         ""
       end
     end
 
-    def after_sync_content
+    def callback_file_content
       <<-'CONTENT'
-require 'bundler'
-require 'open4'
-
-Bundler.with_clean_env do
+class GorgonCallbacks < Gorgon::DefaultCallbacks
   BUNDLE_LOG_FILE||="/tmp/gorgon-bundle-install.log "
+  def after_sync
+    require 'bundler'
+    require 'open4'
 
-  pid, stdin, stdout, stderr = Open4::popen4 "bundle install > #{BUNDLE_LOG_FILE} 2>&1 "
-
-  ignore, status = Process.waitpid2 pid
+    Bundler.with_clean_env do
 
-  if status.exitstatus != 0
-    raise "ERROR: 'bundle install' failed.\n#{stderr.read}"
-  end
-end
-CONTENT
-    end
+      pid, stdin, stdout, stderr = Open4::popen4 "bundle install > #{BUNDLE_LOG_FILE} 2>&1 "
 
-    def before_creating_workers_content
-      <<-'CONTENT'
-ENV["TEST_ENV_NUMBER"] = Process.pid.to_s
-ENV["RAILS_ENV"] = 'remote_test'
+      ignore, status = Process.waitpid2 pid
 
-pid, stdin, stdout, stderr = Open4::popen4 "TEST_ENV_NUMBER=#{Process.pid.to_s} RAILS_ENV='remote_test' bundle exec rake db:setup"
-ignore, status = Process.waitpid2 pid
+      if status.exitstatus != 0
+        raise "ERROR: 'bundle install' failed.\n#{stderr.read}"
+      end
+    end
+  end
 
-if status.exitstatus != 0
-  raise "ERROR: 'rake db:setup' failed.\n#{stderr.read}\n#{stdout.read}"
-end
+  def before_creating_workers
+    ENV["TEST_ENV_NUMBER"] = Process.pid.to_s
+    ENV["RAILS_ENV"] = 'remote_test'
 
-spec_helper_file = File.expand_path('../../spec_helper.rb', __FILE__)
-test_helper_file = File.expand_path('../../test_helper.rb', __FILE__)
+    pid, stdin, stdout, stderr = Open4::popen4 "TEST_ENV_NUMBER=#{Process.pid.to_s} RAILS_ENV='remote_test' bundle exec rake db:setup"
+    ignore, status = Process.waitpid2 pid
 
-require spec_helper_file if File.exist?(spec_helper_file)
-require test_helper_file if File.exist?(test_helper_file)
-CONTENT
+    if status.exitstatus != 0
+      raise "ERROR: 'rake db:setup' failed.\n#{stderr.read}\n#{stdout.read}"
     end
 
-    def after_creating_workers_content
-      <<-'CONTENT'
-require 'rake'
-load './Rakefile'
+    spec_helper_file = File.expand_path('../../spec_helper.rb', __FILE__)
+    test_helper_file = File.expand_path('../../test_helper.rb', __FILE__)
 
-begin
-  if Rails.env = 'remote_test'
-    Rake::Task['db:drop'].execute
+    require spec_helper_file if File.exist?(spec_helper_file)
+    require test_helper_file if File.exist?(test_helper_file)
   end
-rescue Exception => ex
-  puts "Error dropping test database:\n  #{ex}"
-end
-      CONTENT
-    end
 
-    def before_start_content
-      <<-'CONTENT'
-require 'rake'
-load './Rakefile'
+  def before_start
+    require 'rake'
+    load './Rakefile'
 
-begin
-  Rails.env = 'remote_test'
-  ENV['TEST_ENV_NUMBER'] = Process.pid.to_s
+    begin
+      Rails.env = 'remote_test'
+      ENV['TEST_ENV_NUMBER'] = Process.pid.to_s
 
-  Rake::Task['db:reset'].invoke
+      Rake::Task['db:reset'].invoke
+    end
+  end
+
+  def after_creating_workers
+    require 'rake'
+    load './Rakefile'
+
+    begin
+      if Rails.env = 'remote_test'
+        Rake::Task['db:drop'].execute
+      end
+    rescue Exception => ex
+      puts "Error dropping test database:\n  #{ex}"
+    end
+  end
 end
 
+Gorgon.callbacks = GorgonCallbacks.new
 CONTENT
     end
   end

data/lib/gorgon/version.rb

@@ -1,3 +1,3 @@
 module Gorgon
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 end

data/rsync_transport.md

@@ -0,0 +1,20 @@
+Rsync Transport Documentation
+=============================
+
+In gorgon.json, you can change how files are uploaded from Originator to File Server and downloaded from File Server to Listeners.
+This setting is "rsync_transport" which could be either "ssh" or "anonymous"
+
+SSH Transport
+-------------
+
+If you are using this setting, originator and all listeners should have SSH passwordless access to File Server. You can follow [these steps](http://www.linuxproblem.org/art_9.html) to setup SSH login without password. 
+
+Anonymous Transport
+-------------------
+
+If you are using this setting, you need to run the following in the File Server:
+
+  ```bash
+  mkdir -p ~/.gorgon/file_dir             # here is where gorgon will push files under test
+  gorgon start_rsync ~/.gorgon/file_dir
+  ```

data/tutorial.md

@@ -21,7 +21,7 @@ Run `rspec` and make sure all tests pass.
 
 1. Install [RabbitMQ](https://www.rabbitmq.com/download.html).
 
-2. Add Gorgon to the Gemfile: `gem 'gorgon', '0.7.1'`
+2. Add Gorgon to the Gemfile: `gem 'gorgon', '0.8.1'`
 
 3. `bundle`
 
@@ -58,6 +58,11 @@ Run `rspec` and make sure all tests pass.
   cp config/environments/test.rb config/environments/remote_test.rb
   ```
 
+### Setting up SSH access
+
+In this tutorial, we are using [SSH Transport](/rsync_transport.md) to move source code files. This requires you to have SSH access without password to File Server (in this case, to localhost). 
+To check if you have SSH access without password, running ```ssh localhost``` should not ask for a password. If it asks for a password, follow [these steps](http://www.linuxproblem.org/art_9.html) to setup passwordless SSH access.
+
 ### Run Gorgon Listener
 
 1. Download a listener configuration sample:
@@ -73,13 +78,6 @@ Run `rspec` and make sure all tests pass.
   gorgon listen
   ```
 
-### Run File Server
-
-  ```bash
-  mkdir -p ~/.gorgon/file_dir             # here is where gorgon will push files under test
-  gorgon start_rsync ~/.gorgon/file_dir
-  ```
-
 ### Run Gorgon
 
 Now, you are ready to run Gorgon. 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gorgon
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Justin Fitzsimmons
@@ -270,6 +270,7 @@ files:
 - lib/gorgon_bunny/lib/gorgon_bunny/transport.rb
 - lib/gorgon_bunny/lib/gorgon_bunny/version.rb
 - lib/gorgon_bunny/lib/gorgon_bunny/versioned_delivery_tag.rb
+- rsync_transport.md
 - spec/acceptance/run_tests_spec.rb
 - spec/acceptance_spec_helper.rb
 - spec/callback_handler_spec.rb