salesforce-deploy-tool 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e39596fd885ddd07e3a1c9c0e8bd363170069c6
+  data.tar.gz: ded4c4ea15c4858612ffbcb0e287913d67de420a
+SHA512:
+  metadata.gz: 1549f9f350fcdb641200351f7676a372b10637445b108033548993ea5d7e65d6206f363b8862c0e00a3151999b31879fbe511ec8f5fb8219b11ec23ae4fb7c80
+  data.tar.gz: 00c66b5e8c2c3dc9fe611c617028adf87d65985e58f22cbef21bdcb061169491b5d2dd835fac2f26da3f5b381674f656ae3baff198f095554eec44681f0bf1d1

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.swp

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in salesforce-deploy-tool.gemspec
+gemspec
+
+gem 'git'
+gem 'colorize'
+gem 'dcgen'
+gem 'commander'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Juan Breinlinger
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Salesforce::Deploy::Tool
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'salesforce-deploy-tool'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install salesforce-deploy-tool
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/salesforce-deploy-tool/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/sfd

@@ -0,0 +1,124 @@
+#!/usr/bin/env ruby
+#
+require 'salesforcedeploytool'
+
+CONFIG_FILE = '/etc/salesforce.yaml'
+
+if File.exists? CONFIG_FILE
+  config = YAML::load File.open(CONFIG_FILE).read
+else 
+  puts "error: /etc/salesforce.yaml not found"
+  exit 1
+end
+
+program :version, SalesforceDeployTool::VERSION
+program :description, 'A cli tool to help manage and deploy salesforce environments with git'
+
+command :init do |c|
+  c.syntax = 'sf init [options]'
+  c.summary = 'Initialize salesforce environment from git'
+  c.description = "Clone the #{config[:git_repo]} to #{config[:git_dir]}"
+  c.example 'usage', 'sf init'
+  c.action do |args, options|
+  
+    # Initialize
+    sfdt = SalesforceDeployTool::App.new config
+
+    # Clone
+    sfdt.clone
+
+  end
+end
+
+command :pull do |c|
+  c.syntax = 'sf pull'
+  c.summary = 'Pull code from the environment'
+  c.description = "Pull code from environment and update #{config[:git_dir]}"
+  c.example 'usage:', 'sf pull'
+  c.example 'usage:', 'sf pull -c -d'
+  c.option "--no-clean", "Do not clean the currrent source code before pulling"
+  c.option "--debug", "Verbose output"
+  c.option "--env NAME", "use 'prod' to deploy production or sandbox name"
+  c.action do |args, options|
+
+    # Parameter validation:
+    if options.env.nil? 
+      puts "error: please specify the environment to pull from using --env"
+      exit 1
+    end
+    config[:env] = options.env
+    config[:debug] = options.debug.nil? ? false : true
+
+    # Initialize
+    sfdt = SalesforceDeployTool::App.new config
+
+    # Clean all files from repo
+    sfdt.clean_git_dir unless options.no_clean
+
+    # Pull the changes
+    sfdt.pull "INFO: Pulling changes from #{config[:env]}"
+
+  end
+
+end
+
+
+command :push do |c|
+  c.syntax = 'sf push [options]'
+  c.summary = 'Push code into a sandbox'
+  c.description = ''
+  c.example 'description', "Push the code that is located into #{config[:git_dir]} into the active sandbox"
+  c.option "--env NAME", "use 'prod' to deploy production or sandbox name"
+  c.option "--debug", "Verbose output"
+  c.option "--test", "Deploy and test"
+  c.option "--exclude LIST", "a CSV list of metadata to exclude when creating destructiveChange.xml"
+  c.option "--append", "Disable destructive change and do an append deploy"
+  c.action do |args, options|
+
+    # Parameter validation:
+    if options.env.nil? 
+      puts "error: please specify the environment to pull from using --env"
+      exit 1
+    end
+    config[:env] = options.env
+    config[:debug] = options.debug.nil? ? false : true
+    config[:test] = options.test.nil? ? false : true
+
+    # Initialize
+    sfdt = SalesforceDeployTool::App.new config
+
+    # Pull changes from sandbox to temporary directory:
+    config_tmp = config.clone
+    config_tmp[:git_dir] = config_tmp[:tmp_dir]
+    FileUtils.rm_rf config_tmp[:git_dir] if File.exists? config_tmp[:git_dir]
+    sfdt_tmp = SalesforceDeployTool::App.new config_tmp
+    sfdt_tmp.clone
+    sfdt_tmp.clean_git_dir
+    sfdt_tmp.pull "INFO: Pulling changes from #{config[:env]} to temporary directory #{config[:tmp_dir]} to generate destructiveChanges.xml  "
+
+    # Create destructiveChanges.xml
+    if ! options.append
+      puts "INFO: Creating destructive changes xml"
+      dc_gen = Dcgen::App.new
+      dc_gen.master = File.join(config[:git_dir],'src')
+      dc_gen.destination = File.join(config[:tmp_dir],'src')
+      dc_gen.output = File.join(config[:git_dir],'src','destructiveChanges.xml')
+      dc_gen.exclude = options.exclude.split(',') unless options.exclude.nil?
+
+      # Capture stdout when running generate_destructive_Changes, TODO: fix dcgen
+      stringio = StringIO.new
+      stdout_tmp = $stdout
+      $stdout = stringio unless options.debug
+      dc_gen.generate_destructive_changes
+      $stdout = stdout_tmp
+    end
+
+    # Finally push:
+    sfdt.push
+
+  end
+end
+
+default_command :help
+
+

data/lib/salesforcedeploytool.rb

@@ -0,0 +1,14 @@
+require "rubygems"
+require "commander/import"
+require "git"
+require "pp"
+require "colorize"
+require "logger"
+require "open3"
+require "yaml"
+require "dcgen"
+require "stringio"
+require "salesforcedeploytool/version"
+require "salesforcedeploytool/functions"
+require "salesforcedeploytool/app"
+

data/lib/salesforcedeploytool/app.rb

@@ -0,0 +1,115 @@
+module SalesforceDeployTool
+
+  class App
+
+    def initialize config
+
+      @git_repo = config[:git_repo]
+      @git_dir = config[:git_dir]
+      @env = config[:env]
+      @username = config[:username]
+      @password = config[:password]
+      @debug = config[:debug]
+
+      @server_url = @env == 'prod' ? 'https://login.salesforce.com' : 'https://test.salesforce.com'
+
+    end
+
+    def clone
+
+      if Dir.exists? File.join(@git_dir,'.git')
+        return
+      end
+
+      begin
+        Git.clone(@git_repo, File.basename(@git_dir), :path => File.dirname(@git_dir))
+      rescue => e
+        STDERR.puts "ERROR: A problem occured when cloning #{@git_repo}, error was\n\n"
+        puts e
+        exit 1
+      end
+
+    end
+
+    def clean_git_dir message = nil
+
+      print message
+      Dir[File.join(@git_dir,'src','*')].each do |dir|
+        FileUtils.rm_rf dir unless dir =~ /.*package.xml$/
+      end
+      puts "OK" unless message.nil?
+
+    end
+
+    def pull message = nil
+
+      env_vars = ""
+      env_vars += " SF_USERNAME=" + @username + "." + @env
+      env_vars += " SF_PASSWORD=" + @password
+      env_vars += " SF_SERVERURL=" + @server_url
+      cmd = " ant retrieveCode"
+
+      full_cmd = env_vars + cmd
+
+      Dir.chdir @git_dir
+
+      exec_options = {
+        :stderr => @debug,
+        :stdout => @debug,
+        :spinner => ! @debug,
+        :message => message,
+        :okmsg => "OK",
+        :failmsg => "FAILED",
+      }
+
+      if @debug
+        exec_options[:message] += "\n\n"
+        exec_options[:okmsg] = nil
+        exec_options[:failmsg] = nil
+      end
+
+      exit_code = myexec full_cmd, exec_options
+
+      exit exit_code if exit_code != 0
+
+    end
+
+    def push
+
+      # Set env variables to run ant
+      env_vars = ""
+      env_vars += " SF_USERNAME=" + @username + "." + @env
+      env_vars += " SF_PASSWORD=" + @password
+      env_vars += " SF_SERVERURL=" + @server_url
+
+      # myexec options
+      exec_options = {
+        :stderr   =>  @debug,
+        :stdout   =>  @debug,
+        :spinner  =>  ! @debug,
+        :okmsg    =>  "OK",
+        :failmsg  =>  "FAILED",
+      }
+
+      if @debug
+        exec_options[:okmsg]    =   nil
+        exec_options[:failmsg]  =   nil
+      end
+
+      # Deploy code
+      exec_options[:message] = @test ?  "INFO: Deploying and Testing code to #{@env}:  " : "INFO: Deploying code to #{@env}:  "
+      exec_options[:message]  +=  "\n\n" if @debug
+
+      cmd = @test ? " ant deployAndTestCode" : " ant deployCode"
+      full_cmd = env_vars + cmd
+
+      Dir.chdir @git_dir
+      exit_code = myexec full_cmd, exec_options
+
+      exit exit_code if exit_code != 0
+
+    end
+
+  end
+
+end

data/lib/salesforcedeploytool/functions.rb

@@ -0,0 +1,122 @@
+
+class Pinwheel 
+
+  def initialize
+    @pinwheel = %w{| / - \\}
+  end
+
+  def spin_it
+    print "\b" + @pinwheel.rotate!.first
+  end
+
+  def clean
+    print "\b"
+  end
+
+end
+
+
+def myexec cmd, opts = {}
+  
+  opts[:stderr] = false if opts[:stderr].nil?
+  opts[:stdout] = false if opts[:stdout].nil?
+  opts[:exit_on_error] = true if opts[:exit_on_error].nil?
+  opts[:timeout] = 600 if opts[:timeout].nil?
+  opts[:spinner] = true if opts[:spinner].nil?
+  opts[:message] = false if opts[:message].nil?
+  opts[:okmsg] = false if opts[:okmsg].nil?
+  opts[:failmsg] = false if opts[:failmsg].nil?
+  logger = opts[:logger].nil? ? false : opts[:logger]
+
+  command = File.basename($0)
+  exit_status = 0
+  start = Time.new
+  pinwheel = Pinwheel.new if opts[:spinner]
+
+  # Print header message
+  print opts[:message] if opts[:message]
+
+  stdout_all = ""
+  stderr_all = ""
+  begin 
+    stdin,stdout,stderr,wait_thr = Open3.popen3(cmd)
+    pid = wait_thr.pid
+    # This block uses kernel.select to monitor if there is data on stdout IO 
+    # object every 1 second. Then we use a nonblocking read ... so the whole 
+    # idea is: Check if there is stdin to read, in 1 second unblock and 
+    # try to read. Loop every 1 second over and over the same process until 
+    # the process finishes or timeout is reached.
+    elapsed = 0
+    while wait_thr.status and (elapsed = Time.now - start) < opts[:timeout]
+      Kernel.select([stdout,stderr],nil,nil,1)
+
+      # Read STDIN in a nonblock way.
+      begin
+        stdout_line = stdout.read_nonblock(100) 
+        print stdout_line if opts[:stdout]
+        stdout_all += stdout_line
+        # spin the pinwheel
+        pinwheel.spin_it if opts[:spinner]
+      rescue IO::WaitReadable
+        # Exception raised when there is nothing to read
+      rescue EOFError
+        # Exception raised EOF is reached
+        break
+      end
+
+      # Read STDERR in a nonblock way.
+      begin
+        stderr_line = stderr.read_nonblock(100) 
+        print stderr_line if opts[:stderr]
+        stderr_all += stderr_line
+        # spin the pinwheel
+        pinwheel.spin_it if opts[:spinner]
+      rescue IO::WaitReadable
+        # Exception raised when there is nothing to read
+      rescue EOFError
+        # Exception raised EOF is reached
+        break
+      end
+
+    end
+
+    # Log stdout output
+    logger.info "\n" + stdout_all if logger and ! stdout_all.empty?
+    logger.error "\n" + stderr_all if logger and ! stderr_all.empty?
+
+    if elapsed > opts[:timeout]
+      # We need to kill the process 
+      Process.kill("KILL", pid)
+      timeout_error_message = "Timeout #{opts[:timeout]} exceeded for #{cmd}"
+      logger.error timeout_error_message if logger
+      raise timeout_error_message
+    end
+
+    # Clean the pinwheel
+    pinwheel.clean if opts[:spinner]
+
+    # Handle the exit status:
+    exit_status = wait_thr.value.exitstatus
+
+    # Print fail or ok message
+    if exit_status == 0
+      puts opts[:okmsg] if opts[:okmsg]
+    else
+      puts opts[:failmsg] if opts[:failmsg]
+    end
+
+    # Exit on error
+    if exit_status > 0
+      $stderr.puts "#{command} error: Command returned non zero - error was:\n#{stderr_all}" if opts[:stderr]
+      exit 1 if opts[:exit_on_error]
+    end
+
+  rescue => e
+    $stderr.puts "\n#{command} error: Command failed, error was:\n#{e}".red
+    exit 1 if opts[:exit_on_error]
+    exit_status = 127
+  end
+
+  exit_status
+
+end

data/lib/salesforcedeploytool/version.rb

@@ -0,0 +1,3 @@
+module SalesforceDeployTool
+  VERSION = "0.0.2"
+end

data/salesforce-deploy-tool.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'salesforcedeploytool/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "salesforce-deploy-tool"
+  spec.version       = SalesforceDeployTool::VERSION
+  spec.authors       = ["Juan Breinlinger"]
+  spec.email         = ["<juan.brein@breins.net>"]
+  spec.summary       = %q{A tool to help you at deploying and pulling code and metadata from salesforce}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: salesforce-deploy-tool
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Juan Breinlinger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- "<juan.brein@breins.net>"
+executables:
+- sfd
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/sfd
+- lib/salesforcedeploytool.rb
+- lib/salesforcedeploytool/app.rb
+- lib/salesforcedeploytool/functions.rb
+- lib/salesforcedeploytool/version.rb
+- salesforce-deploy-tool.gemspec
+homepage: ''
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A tool to help you at deploying and pulling code and metadata from salesforce
+test_files: []