travis_github_deployer 0.1.0

data/README.md

@@ -0,0 +1,9 @@
+Travis to Github Deployer
+======================
+
+The Travis to Github Deployer script helps when you want to deploy files from a Travis CI build into a github repository. This is especially useful when you use Github Pages, so that you can push certain build artifacts to the github pages such as coverage, test results or generated documentation
+
+How does it work
+======================
+
+

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/travis_github_deployer

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'travis_github_deployer.rb'
+TravisGithubDeployer.new.deploy

data/lib/travis_github_deployer/git_command_line.rb

@@ -0,0 +1,31 @@
+
+
+class GitCommandLine
+  
+  def clone(repository, destination)
+    git("clone " + repository + " " + destination)
+  end
+  
+  def config(key, value)
+    git("config #{key} '#{value}'")
+  end
+  
+  def config_username(username)
+    config("user.name", username)
+  end
+  
+  def config_email(email)
+    config("user.email", email)
+  end
+  
+  def config_credential_helper_store_file(filename)
+    config("credential.helper", "store --file=#{filename}")
+  end
+  
+  def git(command)
+    output = `git #{command} 2>&1`
+    raise StandardError, "Git command: '#{command}' failed. Message: : " + output unless $?.success?
+    output
+  end
+  
+end

data/lib/travis_github_deployer/travis_github_deployer.rb

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby -w
+
+require 'YAML'
+
+class TravisGithubDeployer
+  
+  def initialize
+    @git = GitCommandLine.new
+  end
+  
+  ## Configuration values
+  
+  def destination_repository
+    @destination_repository
+  end
+  
+  def destination_repository_dir
+    @destination_repository_dir ||= "travis_github_deployer_repository"
+  end
+  
+  def files_to_deploy
+    @files_to_deploy
+  end
+    
+  ## Deployment 
+    
+  def deploy
+    load_configuration
+    clone_destination_repository
+    change_current_directory_to_cloned_repository
+    prepare_credentials_based_on_environment_variables
+    copy_files_in_destination_repository
+    commit_and_push_files
+  end
+
+  ## Preparing for deployment
+
+  def load_configuration
+    configuration = YAML.load_file(".travis_github_deployer.yml")
+    @destination_repository = configuration["destination_repository"]
+    @files_to_deploy = configuration["files_to_deploy"]
+  end
+
+  def clone_destination_repository
+    @git.clone(destination_repository, destination_repository_dir)
+  end
+  
+  def change_current_directory_to_cloned_repository
+    Dir.chdir(destination_repository_dir)
+  end
+
+  def prepare_credentials_based_on_environment_variables
+    set_username_based_on_environment_variable
+    set_email_based_on_environment_variable
+    set_repository_token_based_on_enviroment_variable
+  end
+  
+  def set_repository_token_based_on_enviroment_variable
+    git_token = environment_variable_value("GIT_TOKEN")
+    @git.config_credential_helper_store_file(".git/travis_deploy_credentials")
+    File.open(".git/travis_deploy_credentials", "w") { |credential_file|
+      credential_file.write("https://#{git_token}:@github.com")
+    }
+  end
+  
+  def set_username_based_on_environment_variable
+    @git.config_username(environment_variable_value("GIT_NAME"))
+  end
+  
+  def set_email_based_on_environment_variable
+    @git.config_email(environment_variable_value("GIT_EMAIL"))
+  end
+  
+  def environment_variable_value (environment_variable_name)
+    value = ENV[environment_variable_name]
+    raise StandardError.new("The #{environment_variable_name} environment variable wasn't set.") if value.nil?
+    value
+  end
+    
+  def copy_files_to_deployment_repository
+    
+    files_to_deploy.each { |source_location, destination_location|
+      source = Pathname.new(source_location)
+      destination = Pathname.new("github_pages")
+      destination += destination_location.empty? ? source_location : destination_location
+      FileUtils.copy(source, destination)
+    }
+    
+  end
+  
+  def commit_and_push_files
+  end
+    
+end
+
+
+if __FILE__ == $0 then
+  GithubPagesDeployer.new.deploy
+end

data/lib/travis_github_deployer/version.rb

@@ -0,0 +1,4 @@
+
+module TravisGithubDeployerVersion
+  VERSION = "0.1.0"
+end

data/lib/travis_github_deployer.rb

@@ -0,0 +1,3 @@
+
+require 'travis_github_deployer/git_command_line.rb'
+require 'travis_github_deployer/travis_github_deployer.rb'

data/spec/git_command_line_spec.rb

@@ -0,0 +1,47 @@
+
+require 'travis_github_deployer.rb'
+
+describe "simple ruby interface around git command line" do
+  
+  subject { GitCommandLine.new}
+  
+  it "can do a git clone" do
+    subject.should_receive(:git).with("clone repository destination")
+    subject.clone("repository", "destination")
+  end
+  
+  it "can do a config" do
+    subject.should_receive(:git).with("config key 'value'")
+    subject.config("key", "value")
+  end
+  
+  it "can configure the username" do
+    subject.should_receive(:config).with("user.name", "basvodde")
+    subject.config_username("basvodde")
+  end
+  
+  it "can configure the email" do
+    subject.should_receive(:config).with("user.email", "basv@sokewl.com")
+    subject.config_email("basv@sokewl.com")
+  end
+  
+  it "can configure the credential helper" do
+    subject.should_receive(:config).with("credential.helper", "store --file=filename")
+    subject.config_credential_helper_store_file("filename")
+  end
+  
+  
+  context "do_system" do
+    it "Should be able to do a successful command" do
+      subject.git('version').should start_with("git version")
+    end
+    
+    it "Should be able to raise an StandardError on failed commands" do
+      expect {
+        subject.git('error')
+      }.to raise_error(StandardError, "Git command: 'error' failed. Message: : git: 'error' is not a git command. See 'git --help'.\n\nDid you mean this?\n	rerere\n")
+    end
+  end
+  
+  
+end

data/spec/travis_github_deployer_spec.rb

@@ -0,0 +1,107 @@
+
+require 'travis_github_deployer.rb'
+
+describe "travis github deployer" do
+  
+  subject { TravisGithubDeployer.new}
+    
+  before(:each) do
+    @git = mock
+    GitCommandLine.should_receive(:new).and_return(@git)
+  end
+  
+  it "can deploy to an destination repository" do
+    subject.should_receive(:load_configuration)
+    subject.should_receive(:clone_destination_repository)
+    subject.should_receive(:change_current_directory_to_cloned_repository)
+    subject.should_receive(:prepare_credentials_based_on_environment_variables)
+    subject.should_receive(:copy_files_in_destination_repository)
+    subject.should_receive(:commit_and_push_files)
+    subject.deploy
+  end
+  
+  context "Prepare repository for being able to commit" do
+    
+    it "can clone the destination repository" do
+      subject.should_receive(:destination_repository).and_return("https://github.com/cpputest/cpputest")
+      subject.should_receive(:destination_repository_dir).and_return("destdir")
+      @git.should_receive(:clone).with("https://github.com/cpputest/cpputest", "destdir")
+      
+      subject.clone_destination_repository
+    end
+    
+    it "can change the directory to the cloned directory" do
+      subject.should_receive(:destination_repository_dir).and_return("destinationdir")
+      Dir.should_receive(:chdir).with("destinationdir")
+      subject.change_current_directory_to_cloned_repository
+    end
+        
+    it "Should be able to set the credentials for pushing stuff up" do
+      subject.should_receive(:set_username_based_on_environment_variable)
+      subject.should_receive(:set_email_based_on_environment_variable)
+      subject.should_receive(:set_repository_token_based_on_enviroment_variable)
+      subject.prepare_credentials_based_on_environment_variables
+    end
+    
+    it "Should be able to set the username based on an environment variable" do
+      ENV['GIT_NAME'] = "basvodde"
+      @git.should_receive(:config_username).with("basvodde")
+      subject.set_username_based_on_environment_variable    
+    end
+      
+    it "Should give an error message when the GIT_NAME isn't set" do
+      ENV['GIT_NAME'] = nil
+      expect {subject.set_username_based_on_environment_variable}.to raise_error(StandardError, "The GIT_NAME environment variable wasn't set.")
+    end
+      
+    it "Should be able to set the password based on an environment variable" do
+      ENV['GIT_EMAIL'] = "basv@bestcompanythatexists.com"
+      @git.should_receive(:config_email).with("basv@bestcompanythatexists.com")
+      subject.set_email_based_on_environment_variable
+    end
+      
+    it "Should be able to write the github token based on an environment variable" do
+      credential_file = mock
+      ENV['GIT_TOKEN'] = "Token"
+    
+      @git.should_receive(:config_credential_helper_store_file).with(".git/travis_deploy_credentials")
+      File.should_receive(:open).with(".git/travis_deploy_credentials", "w").and_yield(credential_file)
+      credential_file.should_receive(:write).with("https://Token:@github.com")
+    
+      subject.set_repository_token_based_on_enviroment_variable
+    end  
+  end
+
+  context "Prepare the changes that need to be made commit" do
+    
+    it "should be able to copy a file from the root of the source repository to the root of the destination reportistory" do
+      subject.should_receive(:files_to_deploy).and_return( { "sourcefile" => ""})
+      FileUtils.should_receive(:copy).with(Pathname.new("sourcefile"), Pathname.new("github_pages/sourcefile"))
+      subject.copy_files_to_deployment_repository
+    end
+    
+    it "Should be able to copy multiple files" do
+      subject.should_receive(:files_to_deploy).and_return({ "dir/onefile" => "destonefile", "twofile" => "dir/desttwofile"})
+      FileUtils.should_receive(:copy).with(Pathname.new("dir/onefile"), Pathname.new("github_pages/destonefile"))
+      FileUtils.should_receive(:copy).with(Pathname.new("twofile"), Pathname.new("github_pages/dir/desttwofile"))
+      subject.copy_files_to_deployment_repository      
+    end
+  end
+  
+  it "can read configuration parameters out of the .travis_github_deployer.yml" do
+    configuration = { 
+      "destination_repository" => "https://github.com/cpputest/cpputest.github.io.git",
+      "files_to_deploy" => {
+        "source_dir/source_file" => "destination_dir/destination_file"
+      }
+    }
+    
+    YAML.should_receive(:load_file).with(".travis_github_deployer.yml").and_return(configuration)
+    subject.load_configuration
+    
+    subject.destination_repository.should== "https://github.com/cpputest/cpputest.github.io.git"
+    subject.files_to_deploy.should== { "source_dir/source_file" => "destination_dir/destination_file" }
+    
+  end
+    
+end

data/travis_github_deployer.gemfile

@@ -0,0 +1,21 @@
+# encoding: utf-8
+require File.expand_path('../lib/travis_github_deployer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name    = 'travis_github_deployer'
+  gem.version = TravisGithubDeployerVersion::VERSION
+  gem.date    = Date.today.to_s
+  gem.executables = [ "travis_github_deployer" ]
+
+  gem.summary = "Script to deploy to github from Travis CI"
+  gem.description = "A Script and a library that help in deploying files from Travis CI builds to a Github Repository"
+
+  gem.authors  = ['Bas Vodde']
+  gem.email    = 'basv@odd-e.com'
+  gem.homepage = 'https://github.com/basvodde/travis_github_deployer.rb'
+
+  gem.add_dependency('rake')
+  gem.add_development_dependency('rspec', [">= 2.0.0"])
+
+  gem.files = `git ls-files -- {.,test,spec,lib}/*`.split("\n")
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: travis_github_deployer
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Bas Vodde
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-07-15 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+  type: :development
+  version_requirements: *id002
+description: A Script and a library that help in deploying files from Travis CI builds to a Github Repository
+email: basv@odd-e.com
+executables: 
+- travis_github_deployer
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- bin/travis_github_deployer
+- lib/travis_github_deployer.rb
+- lib/travis_github_deployer/git_command_line.rb
+- lib/travis_github_deployer/travis_github_deployer.rb
+- lib/travis_github_deployer/version.rb
+- spec/git_command_line_spec.rb
+- spec/travis_github_deployer_spec.rb
+- travis_github_deployer.gemfile
+homepage: https://github.com/basvodde/travis_github_deployer.rb
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Script to deploy to github from Travis CI
+test_files: []
+
+has_rdoc: