winci-updater 0.0.1

data/features/step_definitions/jenkins_steps.rb

@@ -0,0 +1,113 @@
+Given /^I have WinCI\-server installed in "([^\"]*)"$/ do |winci_server_path|
+  @winci_server_path = winci_server_path
+
+  # below file gets created after running winci-server/install.bat
+  File.exists?(File.join(winci_server_path, "ruby/bin/ruby.exe")).should == true
+end
+
+When /^I have a Jenkins server running$/ do
+  require 'socket'
+  require 'net/http'
+  begin
+    print "."; $stdout.flush
+    Net::HTTP.start("localhost", "3010") { |http| http.get('/') }
+  rescue Exception => e
+    system "rake --rakefile #{File.join(@winci_server_path, "restart_jenkins.rake")} restart_jenkins"
+  ensure
+  end
+end
+
+When /^there exist job named "([^\"]*)" that pushes successful build to "([^\"]*)" repo$/ do |project_name, production_repo|
+  @project_name = project_name
+
+  FileUtils.rm_rf File.expand_path('var/')
+  FileUtils.mkdir File.expand_path('var/')
+  FileUtils.cp_r(File.expand_path('features/fixtures/files.git'), File.expand_path('var/'))
+
+  # TODO move to separate step
+  # prepare production repo
+  FileUtils.mkdir File.expand_path(File.dirname(production_repo))
+  FileUtils.cp_r(File.expand_path('features/fixtures/files.git'), File.expand_path(production_repo))
+
+  # create job config
+  cfg = Jenkins::JobConfigBuilder.new(:ruby) do |c|
+    c.scm = File.expand_path('var/files.git') #"C:/repos/#{@project_name}.git"
+    c.steps = [
+        # below makes sense when your Rakefile run rspec/cucumber by default
+    [:build_bat_step, "bundle exec rake"],
+    # this will send current code to production repo only after rspec/cucumber passed
+    [:build_bat_step, "git push #{File.expand_path(production_repo)} HEAD:master"]
+    ]
+  end
+
+  job = WinCI::Job.new @project_name, cfg
+
+
+  print "waiting for at most 30 seconds for the server to create the job"
+  tries = 0
+  begin
+    print "."; $stdout.flush
+    tries += 1
+
+    # by default creates job on localhost:3010
+    @job_creation_res = job.create
+    raise if not @job_creation_res =~ /.*project created on jenkins.*/
+
+    sleep(10)
+    puts ""
+  rescue Exception => e
+    if tries <= 3
+      sleep 2
+      retry
+    end
+  ensure
+  end
+
+  @job_creation_res.should =~ /.*project created on jenkins.*/
+end
+
+When /^the job has at least one successful build$/ do
+  job = WinCI::Job.new @project_name
+  sha = nil
+  begin
+    sha = job.last_successful_build_sha
+  rescue
+    Jenkins::Api.build_job(@project_name)
+    puts "waiting 40 seconds for the server to build the job"
+    sleep 40
+    sha = job.last_successful_build_sha
+  end
+  sha.should_not be_empty
+end
+
+When /^I run updater with "([^\"]*)" in config$/ do |production_repo|
+  File.open('var/_config.yaml', 'w') do |f|
+    f.puts ":SCMs:"
+    f.puts "- \"#{File.expand_path(production_repo)}\""
+  end
+
+  @git = WinCI::Updater::Git.new "var/_config.yaml"
+  @git.setup_ssh_key "spec/fixtures/key"
+
+  @updater_res = @git.provide File.expand_path('var/'), 'files_cloned', false
+end
+
+When /^I run updater with "([^\"]*)" in config and target dir "([^\"]*)" as parameter$/ do |production_repo, target_dir|
+  File.open(File.expand_path('var/_config.yaml'), 'w') do |f|
+    f.puts ":SCMs:"
+    f.puts "- \"#{File.expand_path(production_repo)}\""
+  end
+
+  @git = WinCI::Updater::Git.new "var/_config.yaml"
+  @git.setup_ssh_key "spec/fixtures/key"
+
+  @updater_res = @git.provide File.expand_path('var/'), 'files_cloned', false
+end
+
+Then /^I should see this$/ do |text|
+  @updater_res.strip.upcase.should contain(text.strip.upcase)
+end
+
+When /^directory named "([^\"]*)" is created$/ do |arg1|
+  File.exists?(File.expand_path('var/files_cloned/.git/')).should be_true
+end

data/features/support/common.rb

@@ -0,0 +1,37 @@
+module CommonHelpers
+  def get_command_output
+    strip_color_codes(File.read(@stdout)).chomp
+  end
+
+  def strip_color_codes(text)
+    text.gsub(/\e\[\d+m/, '')
+  end
+
+  def in_tmp_folder(&block)
+    FileUtils.chdir(@tmp_root, &block)
+  end
+
+  def in_project_folder(&block)
+    project_folder = @active_project_folder || @tmp_root
+    FileUtils.chdir(project_folder, &block)
+  end
+
+  def in_home_folder(&block)
+    FileUtils.chdir(@home_path, &block)
+  end
+
+  def force_local_lib_override(project_name = @project_name)
+    rakefile = File.read(File.join(project_name, 'Rakefile'))
+    File.open(File.join(project_name, 'Rakefile'), "w+") do |f|
+      f << "$:.unshift('#{@lib_path}')\n"
+      f << rakefile
+    end
+  end
+
+  def setup_active_project_folder project_name
+    @active_project_folder = File.join(@tmp_root, project_name)
+    @project_name = project_name
+  end
+end
+
+World(CommonHelpers)

data/features/support/env.rb

@@ -0,0 +1,20 @@
+$:.unshift(File.expand_path(File.dirname(__FILE__) + "/../../lib"))
+require 'winci-updater.rb'
+require 'bundler/setup'
+require 'jenkins'
+require 'winci'
+
+Before do
+  @tmp_root = File.dirname(__FILE__) + "/../../tmp"
+  @home_path = File.expand_path(File.join(@tmp_root, "home"))
+  @lib_path = File.expand_path(File.dirname(__FILE__) + "/../../lib")
+  FileUtils.rm_rf @tmp_root
+  FileUtils.mkdir_p @home_path
+  ENV['HOME'] = @home_path
+  ENV['CUCUMBER_RUNNING'] = 'oooh yes'
+end
+
+After do
+  ENV.delete('JENKINS_HOST')
+  ENV.delete('JENKINS_PORT')
+end

data/features/support/matchers.rb

@@ -0,0 +1,9 @@
+module Matchers
+  RSpec::Matchers.define :contain do |expected_text|
+    match do |text|
+      text.index expected_text
+    end
+  end
+end
+
+World(Matchers)

data/features/works_with_continuous_delivery.feature

@@ -0,0 +1,18 @@
+Feature: Works with WinCI continuous delivery process
+  In order to enhance provisioning in continuous delivery process
+  As a project developer
+  I want to fully integrate updater with WinCI continuous delivery process
+
+  Background:
+    Given I have WinCI-server installed in "C:/winci-server"
+    And I have a Jenkins server running
+    And there exist job named "files" that pushes successful build to "var/production/files.git" repo
+    And the job has at least one successful build
+
+  Scenario: Download last successful build
+    When I run updater with "var/production/files.git" in config and target dir "files_cloned" as parameter
+    Then I should see this
+    """
+    Update successful!
+    """
+    And directory named "files_cloned" is created

data/lib/winci-updater.rb

@@ -0,0 +1,6 @@
+module WinCI
+  module Updater
+    require 'winci-updater/version'
+    require 'winci-updater/git'
+  end
+end

data/lib/winci-updater/const.rb

@@ -0,0 +1,57 @@
+require "logger"
+
+module WinCI
+  module Updater
+
+    UPDATER_WINDOW_TITLE = 'Updater'
+
+    LOG_FILE = 'git_responses.log' # file used to log git command responses
+    LOGGER_LEVEL = Logger::DEBUG # possible values: Logger::DEBUG, Logger::INFO, Logger::WARN, Logger::ERROR, Logger::FATAL
+
+    TOLERATED_STASH_MESSAGES = [\
+    'No local changes to save', \
+    'Saved working directory .*HEAD is now at .*',\
+    ]
+
+    # actually they are not messages from 'pull' but from 'merge' which is part of 'pull' command
+    TOLERATED_PULL_MESSAGES = [\
+    'Already up-to-date.', \
+    'Updating .*', \
+    'Merge made by recursive..*',\
+    ]
+
+    TOLERATED_CLONE_MESSAGES = [\
+    'Already up-to-date.',\
+    ]
+
+    # button constants
+    MB_OK = 0x00000000
+    MB_OKCANCEL = 0x00000001
+    MB_ABORTRETRYIGNORE = 0x00000002
+    MB_YESNOCANCEL = 0x00000003
+    MB_YESNO = 0x00000004
+    MB_RETRYCANCEL = 0x00000005
+    MB_SETFOREGROUND = 0x00010000
+    MB_TOPMOST = 0x00040000
+    MB_ICONEXCLAMATION = 0x00000030
+    MB_CANCELTRYCONTINUE = 0x00000006
+    MB_ICONHAND = 0x00000010
+    MB_ICONQUESTION = 0x00000020
+    MB_ICONASTERISK = 0x00000040
+    MB_USERICON = 0x00000080
+    MB_ICONWARNING = MB_ICONEXCLAMATION
+    MB_ICONERROR = MB_ICONHAND
+    MB_ICONINFORMATION = MB_ICONASTERISK
+    MB_ICONSTOP = MB_ICONHAND
+
+    # return code constants
+    CLICKED_OK = 1
+    CLICKED_CANCEL = 2
+    CLICKED_ABORT = 3
+    CLICKED_RETRY = 4
+    CLICKED_IGNORE = 5
+    CLICKED_YES = 6
+    CLICKED_NO = 7
+
+  end
+end

data/lib/winci-updater/core_ext/string.rb

@@ -0,0 +1,9 @@
+class String
+  def match_any?(arrayOfPatterns)
+    arrayOfPatterns.each do |pattern|
+      result = self.match(/#{pattern}/m)
+      return true if result
+    end
+    return false
+  end
+end

data/lib/winci-updater/git.rb

@@ -0,0 +1,134 @@
+require 'rubygems'
+require 'dl'
+require 'yaml'
+
+require "optparse"
+require "date"
+require "pathname"
+require "fileutils"
+require "git"
+
+require 'winci-updater/git_ext/git'
+require 'winci-updater/git_ext/lib'
+require 'winci-updater/git_ext/base'
+require 'winci-updater/core_ext/string'
+require 'winci-updater/const'
+require 'winci-updater/logger'
+
+module WinCI
+  module Updater
+    class Git
+      def initialize config_path="_config.yaml"
+        @config = YAML.load_file(config_path)
+
+        # create new log file periodically -- each month/week/day
+        $log = TLogger.new(LOG_FILE, 'monthly', STDOUT, true) # possible values: 'monthly', 'weekly', 'daily'
+        # limit the output
+        $log.level = LOGGER_LEVEL
+
+        $log.info("\r\n\r\n\r\nStarting script...\r\n\r\n")
+
+        ensure_git_available
+      end
+
+      def ensure_git_available
+        if File.exists?("../PortableGit/bin/git.exe")
+          git_dir = File.expand_path('../PortableGit/bin', File.dirname(__FILE__))
+          ENV['PATH'] = ENV['PATH'] + ';' + git_dir
+        else
+          # check if git.exe is on PATH
+          begin
+            `git status`
+          rescue
+            raise "Cannot find Git installation! Please reinstall using Git-1.7.0.2-preview20100309.exe or simmilar file!\r\n" +
+                      "The file can be obtained from here: http://code.google.com/p/msysgit/downloads"
+          end
+        end
+      end
+
+      def setup_ssh_key key_path="key"
+        res = ::Git.setup_ssh_key key_path
+        if not res
+          res = 'Error while creating ssh-agent or adding ssh key!'
+        end
+        raise res if not res['Identity added']
+        @ssh_agent_enabled = true
+      end
+
+      def provide_scm scm, localPath
+        if File.directory?(localPath)
+          $log.info("\r\nUpdating '#{localPath}' repository")
+          g = ::Git.open(localPath, :log => $log)
+          # before overwriting with pull, here we do backup of any user made changes to files in the repo
+          res = g.stash(:save => true, :message => 'Changes made by user')
+          if not res.match_any? TOLERATED_STASH_MESSAGES then
+            @not_tolerated_messages << res
+            return
+          end
+
+          # update the repo
+          # Note: this command can return 'Already up to date' message
+          res = g.pull("origin", "origin/master")
+          if not res.match_any? TOLERATED_PULL_MESSAGES then
+            @not_tolerated_messages << res
+            return
+          end
+        else # we clone it if it doesnt exist yet
+          $log.info("\r\nCloning '#{localPath}' repository")
+          opts = {}
+          opts[:depth] = 1
+          g = ::Git.clone(scm, localPath, opts)
+        end
+      end
+
+      def provide target_dir = "./", target_repo_name = nil, handle_failure = true
+        @not_tolerated_messages = []
+
+        begin
+
+          @config[:SCMs].each do |scm|
+            begin
+              target_repo_name = File.basename(scm, '.*') if not target_repo_name
+              provide_scm(scm, File.join(target_dir, target_repo_name))
+            rescue ::Git::GitExecuteError => e
+              @not_tolerated_messages << e
+            end
+          end
+
+          msg = ''
+          buttons = MB_SETFOREGROUND | MB_OK
+          if @not_tolerated_messages.length > 0
+            msg = "Unknown message received while updating, please consult developement team.\r\n"+
+                "It is possible that the message means success.\r\n"+"DETAILS:\r\n" + @not_tolerated_messages.join("\r\n")
+            buttons = MB_ICONERROR | buttons
+          else
+            msg = "Update Successful!"
+          end
+
+          $log.info("\r\n\r\nSUMMARY:\r\n")
+          $log.info(msg)
+          if handle_failure
+            puts msg
+            message_box(msg, UPDATER_WINDOW_TITLE, buttons)
+          else
+            return msg
+          end
+
+        rescue => e
+          msg = e.message.gsub('uncaught throw ', '')
+          $log.error(msg)
+          if handle_failure
+            puts msg
+            message_box("Update Failed! #{msg}", UPDATER_WINDOW_TITLE, buttons=MB_OK | MB_SETFOREGROUND | MB_ICONERROR)
+          else
+            raise
+          end
+        ensure
+          ::Git.kill_ssh_agent if @ssh_agent_enabled
+          @ssh_agent_enabled = nil
+        end
+      end
+
+    end
+  end
+end

data/lib/winci-updater/git_ext/base.rb

@@ -0,0 +1,30 @@
+module Git
+
+  class Base
+
+    def self.setup_ssh_key(ssh_key_path)
+      Git::Lib.new.setup_ssh_key(ssh_key_path)
+    end
+
+    def self.kill_ssh_agent
+      Git::Lib.new.kill_ssh_agent
+    end
+
+    def show_head_names
+      self.lib.show_head_names
+    end
+
+    # cleans a git repository locally
+    def clean(opts = {})
+      # run git-clone
+      self.lib.clean(opts)
+    end
+
+    def stash(opts = {})
+      # run git-stash
+      self.lib.stash(opts)
+    end
+
+  end
+
+end