caracara 0.0.0.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 73d2514d4beb7b3e72836421a49f74d86609d536
+  data.tar.gz: 1d53094514ab617caa62cbad1e4b87c484a1c98e
+SHA512:
+  metadata.gz: d6398fc70be01d80e5447c901f6341f1bcdb1c720fc29c230de3c9d3f3b6e4636c5405c9190746d1694aeac33ee7709f18ea17f3fcafdc279ce13d235459ca2b
+  data.tar.gz: f4d348856521c22e484c5ff44d68facc86f60f57c63f971528cbe30fed0ac63f73cd120a147878943d6bbefdeded841735f2b5ff3845c2bac65d749a179d80a4

data/Dockerfile

@@ -0,0 +1,17 @@
+# Ruby Image
+FROM ruby:2.2.0
+
+# Install Bundler
+RUN gem install bundler --no-ri --no-rdoc
+
+# Make the app folder
+RUN mkdir caracara/
+
+# Set workdir
+WORKDIR caracara/
+
+# Add the rest of the source
+ADD . .
+
+# Bundle install it
+RUN bundle install

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    caracara (0.0.0.pre.alpha)
+      mustache (~> 1.0)
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    mustache (1.0.2)
+    rake (10.4.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  caracara!
+  rspec (~> 3.0.0)
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -0,0 +1,32 @@
+# Caracara
+Task runner based on [Envoy](http://laravel.com/docs/5.1/envoy) and [Mina](http://mina-deploy.github.io/mina/)
+
+# Concepts
+**Task**: Everything is based on this entity, it has steps that are the commands that will be performed somewhere. ~~Ex: git-clone~~
+**Group**: Group of tasks that represents an business operation. ~~Ex: deploy~~
+
+# Usage
+How to use this crazy gem.
+
+**Define a task**
+```ruby
+class GitCloneTask < Caracara::Task
+  # Clone the repository
+  step 'git clone {{repository}} {{dest}} --recursive'
+
+  # Run commands inside the repo folder
+  dir '{{dest}}' do
+    # Checkout to the lastest tag
+    step 'git checkout {{version}}'
+
+    # Remove .git/ folder
+    step ''
+  end
+end
+```
+
+# Development
+* **Generating docker image**
+  * `docker build -t caracara .`
+* **Running the RSpec (for shell fish)**
+  * `docker run -v (pwd):/caracara --rm caracara bundle exec rspec`

data/caracara.gemspec

@@ -0,0 +1,20 @@
+require './lib/caracara/version'
+
+Gem::Specification.new do |s|
+  s.name = 'caracara'
+  s.version = Caracara.version
+  s.summary = ''
+  s.description = ''
+  s.author = 'Gabriel Corado'
+  s.email = 'gabrielcorado@mail.com'
+  s.homepage = 'http://github.com/gabrielcorado/caracara'
+
+  s.files = `git ls-files`.strip.split("\n")
+  s.executables = Dir["bin/*"].map { |f| File.basename(f) }
+
+  s.add_dependency 'rake'
+  s.add_dependency 'mustache', '~> 1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.0.0'
+  # s.add_dependency 'open4', '~> 1.3.4'
+end

data/lib/caracara/group.rb

@@ -0,0 +1,69 @@
+#
+module Caracara
+  # Group
+  class Group
+    # Tasks
+    attr_reader :tasks
+
+    # Initialize
+    def initialize(tasks = [])
+      @tasks = tasks
+    end
+
+    # Tasks access
+    def tasks
+      # Map the tasks
+      @tasks.map do |task|
+        task
+      end
+    end
+
+    # Compile the tasks
+    def compile(args = {})
+      # Each the steps
+      @tasks.map do |task|
+        # Compile the task
+        task.compile args
+      end
+    end
+
+    # Generate the SSH command
+    def command(args = {}, escape = true)
+      # Each tasks
+      tasks = @tasks.map do |task|
+        task.command args, false
+      end
+
+      # Generate the full command
+      SSH.command tasks, escape
+    end
+
+    # Static methods
+    class << self
+      # Tasks
+      attr_reader :tasks
+
+      # Set a new task to the group
+      def task(command)
+        # Check the type of the command
+        if command.is_a? String
+          task = Task.new [command]
+        else
+          task = command.init
+        end
+
+        # Init the tasks
+        @tasks = [] if @tasks.nil?
+
+        # Push it to the tasks
+        @tasks.push task
+      end
+
+      # Init
+      def init
+        new @tasks
+      end
+
+    end
+  end
+end

data/lib/caracara/ssh.rb

@@ -0,0 +1,69 @@
+# Include shellwords
+require 'shellwords'
+
+#
+module Caracara
+  # SSH class
+  class SSH
+    # Static methods
+    class << self
+      # Login command
+      def login(user, host, options = {})
+        # Basic command
+        command = "ssh #{user}@#{host}"
+
+        # Identity file
+        command << " -i #{options[:key]}" unless options[:key].nil?
+
+        # Port
+        command << " -p #{options[:port]}" unless options[:port].nil?
+
+        # Forward agent
+        command << ' -A' if options[:forward_agent]
+
+        # Check strict host key
+        command << ' -o StrictHostKeyChecking=no'
+
+        # Disable pseudo terminal
+        command << ' -T'
+      end
+
+      # Escape the command
+      def escape(cmd)
+        Shellwords.escape cmd
+      end
+
+      # Generate a command
+      def command(cmd, escape = true)
+        # Joing commands
+        cmd = cmd.join("\n") if cmd.is_a? Array
+
+        # Escape the command
+        cmd = escape(cmd) if escape
+
+        # Return the command
+        cmd
+      end
+
+      # Generate the SSH command
+      def generate(user, host, cmd, ssh_options = {})
+        "#{login(user, host, ssh_options)} -- #{command(cmd)}"
+      end
+
+      # Exec the SSH command
+      def exec(cmd)
+        # System the command
+        result = `#{cmd}`
+
+        # Return the status
+        status = $?.to_i
+
+        # Return the status `true` for success and `false` for error
+        {
+          result: result,
+          status: !(status.is_a?(Fixnum) && status > 0)
+        }
+      end
+    end
+  end
+end

data/lib/caracara/task.rb

@@ -0,0 +1,57 @@
+#
+module Caracara
+  # Task class
+  class Task
+    # Task steps
+    @steps = []
+
+    # Initialize
+    def initialize(steps)
+      @steps = steps
+    end
+
+    # Steps
+    def steps
+      @steps
+    end
+
+    # Compile the tasks
+    def compile(args = {})
+      # Each the steps
+      @steps.map do |step|
+        # Compile the mustache template
+        Mustache.render step, args
+      end
+    end
+
+    # Generate the SSH command
+    def command(args = {}, escape = true)
+      SSH.command compile(args), escape
+    end
+
+    # Static methods
+    class << self
+      # Task steps
+      attr_reader :steps
+
+      # Run commands inside a dir
+      # @TODO
+      def dir(name)
+      end
+
+      # Add a step
+      def step(cmd)
+        # Define the step
+        @steps = [] if @steps.nil?
+
+        # Add a new step
+        @steps.push cmd
+      end
+
+      def init
+        # Create a new instance
+        new @steps
+      end
+    end
+  end
+end

data/lib/caracara/version.rb

@@ -0,0 +1,5 @@
+module Caracara
+  def self.version
+    '0.0.0.alpha'
+  end
+end

data/lib/caracara.rb

@@ -0,0 +1,11 @@
+# Define the module
+module Caracara
+end
+
+# Mustache
+require 'mustache'
+
+# Include the sources
+require 'caracara/ssh'
+require 'caracara/task'
+require 'caracara/group'

data/spec/caracara/group_spec.rb

@@ -0,0 +1,50 @@
+# Include the helper
+require 'spec_helper'
+
+# Define a simple task
+class FolderTask < Caracara::Task
+  step 'mkdir {{folder}}/'
+  step 'chmod -R 775 {{folder}}/'
+end
+
+# Define a new group
+class GroupSpec < Caracara::Group
+  # Define a task from a class
+  task FolderTask
+
+  # Simple task
+  task 'mv anotherFolder/file.txt {{folder}}/movedFile.txt'
+end
+
+# Kickstart with the tests
+describe 'Groups' do
+  # Initialize the group
+  let(:group) { GroupSpec.init }
+
+  it 'should return the right tasks from GroupSpec' do
+    # Get the tasks
+    tasks = group.tasks
+
+    # Assertions
+    expect(tasks[0]).to be_an_instance_of(FolderTask)
+    expect(tasks[1]).to be_an_instance_of(Caracara::Task)
+  end
+
+  it 'should return the compiled tasks' do
+    # Get the compile tasks
+    tasks = group.compile folder: 'niceFolder'
+
+    # Assertions
+    expect(tasks[0][0]).to eq('mkdir niceFolder/')
+    expect(tasks[0][1]).to eq('chmod -R 775 niceFolder/')
+    expect(tasks[1][0]).to eq('mv anotherFolder/file.txt niceFolder/movedFile.txt')
+  end
+
+  it 'should return the group command' do
+    # Get the command
+    command = group.command folder: 'niceFolder'
+
+    # Assertions
+    expect(command).to eq("mkdir\\ niceFolder/'\n'chmod\\ -R\\ 775\\ niceFolder/'\n'mv\\ anotherFolder/file.txt\\ niceFolder/movedFile.txt")
+  end
+end

data/spec/caracara/ssh_spec.rb

@@ -0,0 +1,65 @@
+# Include the helper
+require 'spec_helper'
+
+# Tests
+describe 'SSH' do
+  context 'login' do
+    it 'should be generated without all the params' do
+      # Generate the SSH command
+      command = Caracara::SSH.login 'user', 'localhost'
+
+      # Assertions
+      expect(command).to eq('ssh user@localhost -o StrictHostKeyChecking=no -T')
+    end
+
+    it 'should be generated with all the param' do
+      # Generate the SSH command
+      command = Caracara::SSH.login 'user', 'localhost', key: '~/my-key', port: 22, forward_agent: true
+
+      # Assertions
+      expect(command).to eq('ssh user@localhost -i ~/my-key -p 22 -A -o StrictHostKeyChecking=no -T')
+    end
+  end
+
+  context 'string command' do
+    it 'should be generated with a string command' do
+      # Generate command
+      command = Caracara::SSH.command %{ls -la}
+
+      # Assertions
+      expect(command).to eq('ls\\ -la')
+    end
+
+
+    it 'should be generated with an array of commands' do
+      # Generate commands
+      commands = Caracara::SSH.command([
+        'ls -la',
+        'pwd'
+      ])
+
+      # Assertions
+      expect(commands).to eq("ls\\ -la'\n'pwd")
+    end
+  end
+
+  it 'should generate the SSH command' do
+    # Generate command
+    command = Caracara::SSH.generate 'user', 'localhost', %{ls -la}
+
+    # Assertions
+    expect(command).to eq('ssh user@localhost -o StrictHostKeyChecking=no -T -- ls\\ -la')
+  end
+
+  it 'should execute the SSH command' do
+    # Generate command
+    command = Caracara::SSH.generate 'ubuntu', 'localhost', %{ls -la}
+
+    # Run the command
+    result = Caracara::SSH.exec command
+
+    # Assertions
+    # it should return false because ssh localhost it not enable
+    expect(result[:status]).to eq(false)
+  end
+end

data/spec/caracara/task_spec.rb

@@ -0,0 +1,49 @@
+# Include the helper
+require 'spec_helper'
+
+# Class definitions
+class TaskSpec < Caracara::Task
+  step 'mkdir {{folder.name}}/'
+  step 'chown -R {{user}} {{folder.name}}'
+  step 'chmod -R {{folder.permission}} {{folder.name}}/'
+end
+
+class TaskTwoSpec < Caracara::Task
+  step 'mkdir {{folder.name}}/'
+  step 'chown -R {{user}} {{folder.name}}'
+  step 'chmod -R {{folder.permission}} {{folder.name}}/'
+end
+
+# Tests
+describe 'Task' do
+  # Initialize the task
+  let(:task) { TaskSpec.init }
+
+  it 'should return the steps' do
+    # Get the steps
+    steps = task.steps
+
+    # Assertions
+    expect(steps[0]).to eq('mkdir {{folder.name}}/')
+    expect(steps[1]).to eq('chown -R {{user}} {{folder.name}}')
+    expect(steps[2]).to eq('chmod -R {{folder.permission}} {{folder.name}}/')
+  end
+
+  it 'should compile the steps' do
+    # Get the steps
+    steps = task.compile user: 'ubuntu', folder: { name: 'niceFolder', permission: 755 }
+
+    # Assertions
+    expect(steps[0]).to eq('mkdir niceFolder/')
+    expect(steps[1]).to eq('chown -R ubuntu niceFolder')
+    expect(steps[2]).to eq('chmod -R 755 niceFolder/')
+  end
+
+  it 'should generate the SSH command' do
+    # Command
+    command = task.command user: 'ubuntu', folder: { name: 'niceFolder', permission: 755 }
+
+    # Assertions
+    expect(command).to eq("mkdir\\ niceFolder/'\n'chown\\ -R\\ ubuntu\\ niceFolder'\n'chmod\\ -R\\ 755\\ niceFolder/")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+# Include Caracara
+require 'caracara'
+
+# Rspec conf
+RSpec.configure do |config|
+  config.order = 'random'
+  config.seed = '12345'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: caracara
+version: !ruby/object:Gem::Version
+  version: 0.0.0.alpha
+platform: ruby
+authors:
+- Gabriel Corado
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: ''
+email: gabrielcorado@mail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- README.md
+- caracara.gemspec
+- lib/caracara.rb
+- lib/caracara/group.rb
+- lib/caracara/ssh.rb
+- lib/caracara/task.rb
+- lib/caracara/version.rb
+- spec/caracara/group_spec.rb
+- spec/caracara/ssh_spec.rb
+- spec/caracara/task_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/gabrielcorado/caracara
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []