designshell 0.0.1

data/lib/designshell/utils.rb

@@ -0,0 +1,18 @@
+module DesignShell
+	module Utils
+		def self.lookupItems(aDeployNode, aKeyChain)
+			result = {}
+			REXML::XPath.each(aDeployNode,'item') do |n|
+				name = n.attribute('name').to_s.to_nil
+				key = n.attribute('key').to_s.to_nil || name
+				next unless name
+				if text = n.text.to_nil             # value in node
+					result[name] = text
+				else                                # value in @params['deploy_creds']
+					result[key] = aKeyChain.get(key.to_sym) if key
+				end
+			end
+			result
+		end
+	end
+end

data/lib/designshell/version.rb

@@ -0,0 +1,3 @@
+module DesignShell
+  VERSION = '0.0.1'
+end

data/lib/designshell.rb

@@ -0,0 +1,19 @@
+require 'designshell/version'
+require 'osx_keychain'
+require 'gli'
+require 'git'
+require 'buzzcore'
+require 'buzzcore_mods'
+require 'termios'
+require 'highline/import'
+require 'fileutils'
+require 'net/ssh'
+require 'uri'
+
+require 'designshell/utils'
+require 'designshell/context'
+require 'designshell/key_chain'
+require 'designshell/repo'
+require 'designshell/repo_server'
+require 'designshell/deploy_plan'
+require 'designshell/core'

data/lib/designshellserver/command.rb

@@ -0,0 +1,180 @@
+module DesignShellServer
+	class Command
+
+		attr_accessor :core,:context,:line,:command,:id,:params,:repo
+
+		def initialize(aCore,aLine,aCommandName=nil)
+			@core = aCore
+			@context = aCore && aCore.context
+			@line = aLine
+			tl = aLine.dup
+			cmd = tl.extract!(/^[A-Z0-9_]+/)
+			@command = aCommandName || cmd
+			tl.bite! ' '
+			@id = tl.extract!(/^[a-z0-9]+/)
+			tl.bite! ' '
+			@params = ::JSON.parse(tl) if @params = tl.to_nil
+		end
+
+		def execute
+			self.send @command.to_sym
+		end
+
+		def writeline(aString)
+			@context.stdout.puts aString
+		end
+
+		# Prepares repo in cache dir for site
+		# requires params: repo_url,site
+		def prepare_cache # {:url=>'git://github.com/ddssda', :branch=>'master', :commit=>'ad452bcd'}
+			url = @params['repo_url']
+			site = @params['site']
+			wd = @core.working_dir_from_site(site)
+
+			@repo = DesignShell::Repo.new
+			suitable = if File.exists?(wd)
+				@repo.open wd
+				@repo.origin.url==url
+			else
+				false
+			end
+
+			if suitable
+				@repo.fetch
+			else
+				if File.exists? wd
+					raise RuntimeError.new('almost did bad delete') if !@core.cache_dir || @core.cache_dir.length<3 || !wd.begins_with?(@core.cache_dir)
+					FileUtils.rm_rf wd
+				end
+				@repo.clone(url, wd)
+			end
+		end
+
+		# Switches @repo to given branch and/or commit
+		# Should call prepare_cache first to create @repo
+		# requires params: branch and/or commit
+		def checkout_branch_commit
+			#url = @params['repo_url']
+			#site = @params['site']
+			#wd = @core.working_dir_from_site(site)
+			branch = @params['branch'] || 'master'
+			commit = @params['commit']
+			@repo.checkout(commit,branch)
+			#perhaps use reset --hard here
+			if (commit)
+				@repo.merge(commit,['--ff-only'])
+			else
+				@repo.merge('origin/'+branch,['--ff-only'])
+			end
+		end
+
+		# Determines whether to do an incremental or complete deploy and deploys current files in repo working dir to repo_url
+		# requires :
+		#   uses: site_client.deploy_status
+		#   params: deploy_cred
+		def deploy
+			deployPlanString = @repo.get_file_content('.deploy_plan.xml',@params['commit']||@params['branch'])
+			xmlRoot = XmlUtils.get_xml_root(deployPlanString)
+			# select plan
+			planNode = XmlUtils.single_node(xmlRoot,'plan')
+			# for each deploy
+			deployNode = XmlUtils.single_node(planNode,'deploy')
+			# create client for kind/method
+			@site_client = DesignShell::SiteClient.new({
+				:site_url => @params['site_url'],
+				:site_username => @params['site_username'],
+				:site_password => @params['site_password'],
+			})
+			ds = @site_client.deploy_status
+			site_repo_url = ds && ds['repo_url'].to_nil
+			site_branch = ds && ds['branch'].to_nil
+			site_commit = ds && ds['commit'].to_nil
+			repo_url = @repo.url
+			# @todo must limit uploads to build folder
+			fromPath = MiscUtils.ensure_slashes(XmlUtils.peek_node_value(deployNode,'fromPath','/'),false,true)    # eg. /build/bigcommerce effectively selects a subfolder that should be debased
+			toPath = MiscUtils.ensure_slashes(XmlUtils.peek_node_value(deployNode,'toPath','/'),false,true)    # eg. / effectively the new base for these files
+			if site_repo_url && site_repo_url==repo_url && site_branch && site_commit
+				# incremental
+				changes = @repo.changesBetweenCommits(site_commit,@repo.head.to_s)
+				uploads,deletes = convertChangesToUploadsDeletes(changes)
+				uploads.delete_if { |fp| !fp.begins_with?(fromPath) }
+				deletes.delete_if { |fp| !fp.begins_with?(fromPath) }
+				@site_client.delete_files(deletes,fromPath,toPath)
+				@site_client.upload_files(@repo.path,uploads,fromPath,toPath)
+				@site_client.deploy_status = {
+					:repo_url => @repo.url,
+					:branch => @repo.branch,
+					:commit => @repo.head.to_s,
+				  :fromPath => fromPath,
+				  :toPath => toPath
+				}
+			else
+				# complete
+				# for now, just deploy all files in wd, creating folders as necessary
+				# later, delete remote files not in wd except for eg. .deploy-status.xml and perhaps upload folders
+				uploads = MiscUtils.recursive_file_list(@repo.path,false)
+				uploads.delete_if do |fp|
+					!fp.begins_with?(fromPath) || fp.begins_with?('.git/')
+				end
+				@site_client.upload_files(@repo.path,uploads,fromPath,toPath)
+				@site_client.deploy_status = {
+					:repo_url => @repo.url,
+					:branch => @repo.branch,
+					:commit => @repo.head.to_s,
+					:fromPath => fromPath,
+		      :toPath => toPath
+				}
+			end
+		end
+
+		# Added (A), Copied (C), Deleted (D), Modified (M), Renamed (R), have their type (i.e. regular file, symlink, submodule, ...) changed (T)
+		def convertChangesToUploadsDeletes(changes)
+			uploads = []
+			deletes = []
+			changes.each do |line|
+				continue if line==""
+				tabi = line.index("\t")
+				status = line[0,tabi]
+				path = line[tabi+1..-1]
+				if status.index('D')
+					deletes << path
+				else
+					uploads << path
+				end
+			end
+			return uploads,deletes
+		end
+
+		def DUMMY
+			id = StringUtils.random_word(8,8)
+			writeline "RECEIVED "+id
+			sleep 1
+			detail = ::JSON.generate({:this=>5, :that=>'ABC'}) #JSON.parse(document) or JSON.generate(data)
+			writeline ['PROGRESS',id,detail].join(' ')
+			sleep 1
+			detail = ::JSON.generate({:result=>123}) #JSON.parse(document) or JSON.generate(data)
+			writeline ['COMPLETE',id,detail].join(' ')
+		end
+
+		def QUICK
+			id = StringUtils.random_word(8,8)
+			writeline "RECEIVED "+id
+			writeline "COMPLETE "+id
+		end
+
+		def DEPLOY # {}
+			id = StringUtils.random_word(8,8)
+			writeline "RECEIVED "+id
+			detail =
+			writeline ['PROGRESS',id,::JSON.generate({:message => 'preparing cache'})].join(' ')
+			prepare_cache
+			writeline ['PROGRESS',id,::JSON.generate({:message => 'checkout'})].join(' ')
+			checkout_branch_commit
+			writeline ['PROGRESS',id,::JSON.generate({:message => 'deploying'})].join(' ')
+			deploy
+			writeline "COMPLETE "+id
+		end
+
+
+	end
+end

data/lib/designshellserver/core.rb

@@ -0,0 +1,41 @@
+module DesignShellServer
+	class Core
+
+		attr_reader :context
+
+		def initialize(aContext)
+			@context = aContext
+		end
+
+		def make_command(aLine)
+			command_name = aLine.scan(/^[A-Z0-9_]+/).pop.to_nil
+			return nil unless command_name && DesignShellServer::Command.instance_methods.include?(command_name)
+			return DesignShellServer::Command.new(self,aLine,command_name)
+		end
+
+		def run
+			if line = ENV['SSH_ORIGINAL_COMMAND']
+				command = make_command(line)
+				command.execute
+			else
+				@context.stdout.print "\n>"
+				@context.stdin.each_line do |line| line.chomp! "\n"
+					command = make_command(line)
+					command.execute
+					@context.stdout.print "\n>"
+				end
+			end
+		end
+
+		def cache_dir
+			@cache_dir ||= MiscUtils.append_slash(@context.credentials[:cache_dir] || MiscUtils.make_temp_dir('DesignShellServer'))
+		end
+
+		def working_dir_from_site(aSite)
+			return nil unless aSite
+			aSite.gsub!(/[^a-zA-Z0-9.\-_]/,'_')
+			File.join(cache_dir,aSite)
+		end
+
+	end
+end

data/lib/designshellserver.rb

@@ -0,0 +1,17 @@
+require 'git'
+require 'buzzcore'
+require 'buzzcore_mods'
+require 'net/dav'
+require 'json'
+require 'fileutils'
+require 'uri'
+
+#require 'termios'
+#require 'highline/import'
+
+require 'designshell/context'
+require 'designshell/site_client'
+require 'designshell/deploy_plan'
+require 'designshell/repo'
+require 'designshellserver/core'
+require 'designshellserver/command'

data/spec/KeyChain_spec.rb

@@ -0,0 +1,94 @@
+require "rspec"
+require "rspec_helper"
+
+describe "KeyChain" do
+
+	keyChain = nil
+
+	before do
+		keyChain = DesignShell::KeyChain.new('DesignShellTest')
+	end
+
+	it "should write,read,check value" do
+		value = StringUtils.random_word(8,8)
+		keyChain.set('testKey',value)
+		readValue = keyChain.get('testKey')
+		readValue.should == value
+	end
+
+	it "should support get and set with a prefix" do
+		value1 = StringUtils.random_word(8,8)
+		value2 = StringUtils.random_word(8,8)
+		keyChain.set('testKey',value1)
+		keyChain.set('testKey',value2,'blah')
+		keyChain.get('testKey').should==value1
+		keyChain.get('testKey','blah').should==value2
+	end
+
+	it "should support multiple get" do
+		value1 = StringUtils.random_word(8,8)
+		value2 = StringUtils.random_word(8,8)
+		keyChain.set('testKey1',value1)
+		keyChain.set('testKey2',value2)
+		keyChain.get('testKey1').should==value1
+		keyChain.get('testKey2').should==value2
+		keyChain.get(['testKey1']).should=={'testKey1' => value1}
+		keyChain.get(['testKey2']).should=={'testKey2' => value2}
+		keyChain.get(['testKey1','testKey2']).should=={'testKey1' => value1,'testKey2' => value2}
+		keyChain.get(%w(testKey1 testKey2)).should=={'testKey1' => value1,'testKey2' => value2}
+	end
+
+	it "should support multiple get with a prefix" do
+		value1 = StringUtils.random_word(8,8)
+		value2 = StringUtils.random_word(8,8)
+		keyChain.set('testKey1','')
+		keyChain.set('testKey2','')
+		keyChain.set('testKey1',value1,'prefix1.')
+		keyChain.set('testKey2',value2,'prefix1.')
+		keyChain.get(%w(testKey1 testKey2)).should == {'testKey1' => '', 'testKey2' => ''}
+		keyChain.get(%w(testKey1 testKey2),'prefix1.').should == {'testKey1' => value1, 'testKey2' => value2}
+		keyChain.get(%w(testKey1 testKey2),'prefix1.',true).should == {'prefix1.testKey1' => value1, 'prefix1.testKey2' => value2}
+	end
+
+	it "should support multiple set" do
+		value1 = StringUtils.random_word(8,8)
+		value2 = StringUtils.random_word(8,8)
+		keyChain.set({
+			'testKey1' => value1,
+		  'testKey2' => value2
+		})
+		keyChain.get('testKey1').should==value1
+		keyChain.get('testKey2').should==value2
+	end
+
+DEPLOY_XML = <<EOS
+<deploy>
+	<kind>BigCommerce</kind>
+	<method>WebDav</method>
+	<fromPath>/build/bigcommerce</fromPath>
+	<toPath>/</toPath>
+	<item name="itemX">some item x</item>
+	<item name="itemY" key="itemYYY">YYY</item>
+	<item name="itemZ"></item>
+	<item name="itemZZ"/>
+</deploy>
+EOS
+
+	it "should support DesignShell::Utils.lookupItems" do
+		values = {
+			'itemX' => 'never read this',
+			'itemY' => 'never read this',
+			'itemYYY' => 'YYYYY',
+			'itemZ' => 'ZZZ',
+			'itemZZ' => 'ZZZZZ',
+		}
+		keyChain.set(values)
+		deployXml = XmlUtils.get_xml_root(DEPLOY_XML)
+		result = DesignShell::Utils.lookupItems(deployXml,keyChain)
+		result['itemX'].should=='some item x'
+		result['itemY'].should=='YYY'   # text value overrides keychain
+		result['itemZ'].should==values['itemZ']
+		result['itemZZ'].should==values['itemZZ']
+	end
+
+end

data/spec/RepoServer_spec.rb

@@ -0,0 +1,54 @@
+require "rspec"
+require "rspec_helper"
+require "fileutils"
+
+describe "RepoServer" do
+
+	testFolder = nil
+	before do
+		testFolder = Dir.mktmpdir('Repo_spec-')
+
+		cred = Credentials.new(:designshell)
+
+	end
+
+	after do
+		FileUtils.rm_rf testFolder if testFolder
+	end
+
+	it "should list repos" do
+		keyChain = DesignShell::KeyChain.new('DesignShell')
+		#keyChain.set({
+		#	:oauth_token => 'OAuth consumer Key',
+		#	:oauth_secret => 'OAuth consumer Secret',
+		#  :login => 'username, not email address',
+		#  :password => 'user password'
+		#},'RepoServer.')
+		repoServer = DesignShell::RepoServer.new
+		# should move values to credentials that looks up keyChain
+		values = keyChain.get([:oauth_token,:oauth_secret,:login,:password],'RepoServer.').symbolize_keys
+		repoServer.setup(values)
+
+		result = repoServer.repos    #"[#<Hashie::Mash is_private=true name="test1" owner="buzzware" scm="git" slug="test1">]"
+		result.class.should==Array
+		result.length.should > 0
+		result.first.scm.should=='git'
+	end
+
+	it "should clone the first repo" do
+		keyChain = DesignShell::KeyChain.new('DesignShell')
+		repoServer = DesignShell::RepoServer.new
+		values = keyChain.get([:oauth_token,:oauth_secret,:login,:password],'RepoServer.').symbolize_keys
+		repoServer.setup(values)
+		repos = repoServer.repos
+		repos.length.should > 0
+		repo = repos && repos.first
+
+		url = "git@bitbucket.org:#{repo.owner}/#{repo.slug}.git"
+		repo = DesignShell::Repo.new
+		result = repo.clone(url, testFolder)
+		repo.path.should == testFolder
+		repo.branches.class.should == Git::Branches
+	end
+
+end

data/spec/Repo_spec.rb

@@ -0,0 +1,105 @@
+require "rspec"
+require "rspec_helper"
+require "fileutils"
+
+describe "Repo" do
+
+	testFolder = nil
+	before do
+		testFolder = MiscUtils.real_path(Dir.mktmpdir('Repo_spec-'))
+	end
+
+	after do
+		FileUtils.rm_rf testFolder if testFolder
+	end
+
+
+	COMMIT_RESULT1 = "[master (root-commit) 6bdd9e1] first commit  1 files changed, 1 insertions(+), 0 deletions(-)  create mode 100644 file1.txt"
+
+	it "commit should create commit object or string message" do
+		repo = DesignShell::Repo.new
+		repo.init testFolder
+
+		file1 = File.join(testFolder,'file1.txt')
+		content11 = '11111'
+		MiscUtils.string_to_file(content11,file1)
+		repo.add 'file1.txt'
+		commit1 = repo.commit_all('first commit')
+		commit1.class.should == Git::Object::Commit
+
+		commit2 = repo.commit_all('second commit without changes')
+		commit2.should == nil
+	end
+
+	it "create a repo, add file, commit, change, commit, reset, check" do
+		repo = DesignShell::Repo.new
+		repo.init testFolder
+		repo.path.should == MiscUtils.real_path(testFolder)
+
+		file1 = File.join(testFolder,'file1.txt')
+		content11 = '11111'
+		MiscUtils.string_to_file(content11,file1)
+		repo.git.add 'file1.txt'
+		commit1 = repo.commit_all('first commit')
+
+		content12 = '11111-some more text'
+		MiscUtils.string_to_file(content12,file1)
+		commit2 = repo.commit_all('second commit')
+
+		read_content = MiscUtils.string_from_file(file1)
+		read_content.should == content12
+
+		repo.reset_hard(commit1)
+
+		read_content = MiscUtils.string_from_file(file1)
+		read_content.should == content11
+	end
+
+	it "should download a remote repo and check log, then re-open it and check log again" do
+		repo = DesignShell::Repo.new
+		url = "git@github.com:buzzware/underscore_plus.git"
+		repo.clone(url, testFolder)
+		repo.path.should == testFolder
+		repo.log.first.class.should == Git::Object::Commit
+
+		repo = DesignShell::Repo.new
+		repo.open testFolder
+		repo.path.should == testFolder
+		repo.log.first.class.should == Git::Object::Commit
+		repo.origin.url==url
+	end
+
+	it "should download a remote repo and get diffs between commits" do
+		repo = DesignShell::Repo.new
+		url = "git@github.com:buzzware/underscore_plus.git"
+		repo.clone(url, testFolder)
+
+		commit1 = "4b133ff8825bbd488ba61fa3e3b82a5fa746ac6a"
+		commit2 = "d1b8440dc730ceb4471fbe7c42ccfac94ea12799"
+		changes = repo.changesBetweenCommits(commit1,commit2)
+		changes.should==["A\tunderscore_plus.js"]
+		changes = repo.changesBetweenCommits(commit2,commit1)
+		changes.should==["D\tunderscore_plus.js"]
+	end
+
+	it "should get contents of a given file from a given commit" do
+		repo = DesignShell::Repo.new
+		url = "git@github.com:buzzware/underscore_plus.git"
+		repo.clone(url, testFolder)
+
+		commit1 = "4b133ff8825bbd488ba61fa3e3b82a5fa746ac6a"
+		commit2 = "d1b8440dc730ceb4471fbe7c42ccfac94ea12799"
+		file1 = "README.md"
+		file2 = "underscore_plus.js"
+
+		readme = repo.get_file_content(file1,commit1)
+		readme.is_a?(String).should==true
+		readme.size.should > 0
+		code = repo.get_file_content(file2,commit1)
+		code.should==nil
+		code = repo.get_file_content(file2,commit2)
+		code.is_a?(String).should==true
+		code.size.should > 0
+	end
+
+end

data/spec/build_spec.rb

@@ -0,0 +1,29 @@
+require "rspec"
+require "rspec_helper"
+
+describe "build" do
+
+	testFolder = nil
+	before do
+		testFolder = Dir.mktmpdir('Repo_spec-')
+	end
+
+	after do
+		FileUtils.rm_rf testFolder if testFolder
+	end
+
+	#it "should build source folder into build folder" do
+	#	context = DesignShell::Context.new()
+	#	ds = DesignShell::Core.new(:context => context)
+	#	ds.build
+	#end
+
+	#it "should commit the repository" do
+	#	context = DesignShell::Context.new()
+	#	repo = DesignShell::Repo.new
+	#	repo.configure()
+	#	repo.clone("git@github.com:buzzware/underscore_plus.git", testFolder)
+	#	ds = DesignShell::Core.new(:context => context, :repo => repo)
+	#	ds.ensure_repo_open.commit_all(context)
+	#end
+end

data/spec/client_to_server_spec.rb

@@ -0,0 +1,111 @@
+require "rspec"
+require "rspec_helper"
+
+describe "client to server interaction" do
+
+	before do
+		@key_chain = DesignShell::KeyChain.new('DesignShellTest')
+		@credentials = Credentials.new('designshell')
+		Dir.chdir @credentials[:deploy_repo_path]
+		@context = DesignShell::Context.new(
+			:argv=>[],
+			:env=>{},
+		  :stdout=>$stdout,
+		  :stdin=>$stdin,
+		  :stderr=>$stderr,
+		  :key_chain=>@key_chain,
+		  :credentials=>@credentials
+		)
+	end
+
+	it "should call QUICK and get results" do
+		dash = DesignShell::Core.new(
+			:context => @context
+		)
+		result = dash.call_server_command('QUICK')
+		puts result
+		result.begins_with?('RECEIVED').should == true
+		result.index('COMPLETE').should >= 0
+	end
+
+	it "should call deploy" do
+		dash = DesignShell::Core.new(
+			:context => @context
+		)
+		result = dash.deploy
+		puts result
+		result.begins_with?('RECEIVED').should == true
+		result.index('COMPLETE').should >= 0
+	end
+
+
+
+	#it "should connect to SSH server" do
+	#	Net::SSH.start( @context.credentials[:deploy_host],nil) do |ssh|
+	#
+	#		#result = ssh.exec!("ls")
+	#		#puts result
+	#
+	#
+	#		#ssh.open_channel{|channel| #get root privelages
+   #    ##configure behavior of channel
+   #    #channel.on_data{|channel, data|
+   #    #        puts "#{data}"
+   #    #        if data =~ /^Password:/
+   #    #           channel.send_data("#{PASSWORD}\n")
+   #    #        elsif data =~ /root@/
+   #    #            channel.exec("tail /some/log/file.txt")
+   #    #            channel.on_data{"STOP LOOPING, DAMN YOU!"}
+   #    #        end
+   #    #channel.on_close... (etc.)
+	#		#
+   #    #channel.request_pty do |ch,success|
+   #    #        if success
+   #    #        puts "pty successfully obtained"
+   #    #        else
+   #    #        puts "could not obtain pty"
+   #    #        end end
+	#		#
+   #    #channel.exec("sudoshell"){|channel, win| #custom sudo script.
+   #    #        if win
+   #    #           puts "ss command sent"
+   #    #        else puts "ss command FAIL"
+   #    #        end
+   #    #}
+	#		#
+	#
+	#		ssh.open_channel do |channel|
+	#		  channel.on_data do |ch, data|
+	#	      puts "got stdout: #{data}"
+	#	      #channel.send_data "something for stdin\n"
+	#	    end
+	#
+	#	    channel.on_extended_data do |ch, type, data|
+	#	      puts "got stderr: #{data}"
+	#	    end
+	#
+	#	    channel.on_close do |ch|
+	#	      puts "channel is closing!"
+	#	    end
+	#
+	#	    channel.request_pty do |ch,success|
+   #       if success
+   #         puts "pty successfully obtained"
+   #       else
+   #         puts "could not obtain pty"
+   #       end
+	#	    end
+	#		  #sleep 1
+	#		  result = channel.exec("DEPLOY") do |ch, success|
+	#		    abort "could not execute command" unless success
+	#		  end
+	#		  channel.wait
+	#			puts result
+	#		end
+	#
+	#		ssh.loop
+	#
+	#	end
+	#end
+
+end

data/spec/designshell_context_spec.rb

@@ -0,0 +1,18 @@
+require "rspec"
+require "rspec_helper"
+
+describe "DesignShell::Context" do
+
+	it "should find repo path upward" do
+		tempdir = MiscUtils.real_path(MiscUtils.make_temp_dir('designshell_context_spec'))
+		Dir.mkdir(git_dir = File.join(tempdir,'.git'))
+		Dir.mkdir(File.join(tempdir,'one'))
+		orange = File.join(tempdir,'one/apple/orange')
+		FileUtils.mkpath(orange)
+		Dir.mkdir(File.join(tempdir,'two'))
+		Dir.chdir(orange)
+		context = DesignShell::Context.new({})
+		context.pwd.should==orange
+		context.find_git_root.should==tempdir
+	end
+end