briefcase 0.4.0

data/spec/git_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Briefcase::Commands::Git do
+
+  before do
+    create_dotfiles_directory
+    create_git_repo
+  end
+
+  after do
+    cleanup_dotfiles_directory
+  end
+
+  it "creates links to existing files" do
+    create_file(dotfiles_path + '/test.txt', 'testing git integration')
+    run_command("git status")
+
+    output_must_contain(/Running git status/)
+  end
+
+end

data/spec/helpers/assertions.rb

@@ -0,0 +1,84 @@
+def directory_must_exist(path)
+  File.directory?(path).must_equal(true, "Expected directory to exist at #{path}")
+end
+
+def directory_must_not_exist(path)
+  File.directory?(path).must_equal(false, "Did not expect directory to exist at #{path}")
+end
+
+def file_must_exist(path)
+  File.file?(path).must_equal(true, "Expected file to exist at #{path}")
+end
+
+def file_must_contain(path, text)
+  file_must_exist(path)
+  # strip trailing whitespace to make it easier to use multiline strings
+  File.read(path).strip.must_equal(text.strip)
+end
+
+def file_must_not_match(path, regex)
+  file_must_exist(path)
+  File.read(path).strip.wont_match(regex)
+end
+
+def file_must_not_exist(path)
+  File.file?(path).must_equal(false, "Expected file to not exist at #{path}")
+end
+
+def symlink_must_exist(path, target)
+  File.exist?(path).must_equal(true, "Expected symlink to exist at #{path}")
+  actual = File.readlink(path)
+  actual.must_equal(target, "Expected symlink to #{target}, was #{actual}")
+end
+
+def symlink_must_not_exist(path)
+  if File.exist?(path)
+    File.file?(path).must_equal true
+  end
+end
+
+def file_must_have_moved(original_path, new_path)
+  file_must_exist(new_path)
+  birthplace = File.open(new_path) do |file|
+    file.read
+  end
+  birthplace.must_equal(original_path, "Expected file at #{new_path} to have been moved from #{original_path}")
+end
+
+def file_must_not_have_moved(path)
+  file_must_exist(path)
+  birthplace = File.open(path) { |file| file.read }
+  birthplace.must_equal(path, "Did not expect file at #{path} to have been moved from #{birthplace}")
+end
+
+def git_ignore_must_include(path)
+  git_ignore_path = File.join(dotfiles_path, '.gitignore')
+  file_must_exist(git_ignore_path)
+  ignore_contents = File.open(git_ignore_path) { |file| file.read }
+  ignore_contents.must_match %r{^#{File.basename(path)}$}
+end
+
+def secret_must_be_stored(yaml_key, key, value)
+  file_must_exist(secrets_path)
+  @secrets = YAML.load_file(secrets_path)
+  @secrets[yaml_key].wont_equal(nil, "Expected YAML secrets file to contain value for key '#{yaml_key}'") 
+  @secrets[yaml_key][key].must_equal(value)
+end
+
+def array_matches_regex(array, regex)
+  array.any? do |element|
+    element.gsub(/\e\[\d+m/, '') =~ regex
+  end
+end
+
+def output_must_contain(*regexes)
+  regexes.all? do |regex|
+    array_matches_regex(@output.lines, regex).must_equal(true, "Could not find #{regex} in: \n#{@output}")
+  end
+end
+
+def output_must_not_contain(*regexes)
+  regexes.any? do |regex|
+    array_matches_regex(@output.lines, regex).must_equal(false, "Found #{regex} in: \n#{@output}")
+  end
+end

data/spec/helpers/commands.rb

@@ -0,0 +1,42 @@
+require "open4"
+
+def run_command(command, expected_status=0, &block)
+  @output = ''
+
+  responses = []
+  def responses.response(regex, text)
+    push([regex, text])
+  end
+
+  if block_given?
+    block.call(responses)
+  end
+
+  ENV['BRIEFCASE_DOTFILES_PATH'] = dotfiles_path
+  ENV['BRIEFCASE_HOME_PATH'] = home_path
+  ENV['BRIEFCASE_SECRETS_PATH'] = secrets_path
+  ENV['BRIEFCASE_TESTING'] = 'true'
+  ENV['RUBYOPT'] = 'rubygems'
+  ENV['BRIEFCASE_EDITOR'] = File.expand_path('../bin/editor', File.dirname(__FILE__))
+
+  full_command = "./bin/briefcase #{command}"
+  full_command << " --trace" if ENV['BRIEFCASE_TEST_TRACE']
+
+  status = Open4.popen4(full_command) do |pid, stdin, stdout, stderr|
+    while output = stdout.gets() || stderr.gets()
+      puts output if ENV['BRIEFCASE_VERBOSE_TEST']
+      @output << output
+      responses.each do |response|
+        regex, text = response
+        stdin.write(text + "\n") if output =~ regex
+      end
+    end
+  end
+
+  exit_status = status.exitstatus
+  unless exit_status == expected_status
+    puts "\n" + @output + "\n" if ENV['BRIEFCASE_TEST_TRACE']
+    fail("Expected exist status of #{expected_status}, got #{exit_status}")
+  end
+
+end

data/spec/helpers/files.rb

@@ -0,0 +1,56 @@
+require 'fileutils'
+include FileUtils
+
+SPEC_ROOT = "/tmp/briefcase_spec_work"
+
+def home_path
+  File.expand_path('briefcase_home', SPEC_ROOT)
+end
+
+def dotfiles_path
+  File.expand_path('briefcase_dotfiles', SPEC_ROOT)
+end
+
+def secrets_path
+  File.expand_path('.briefcase_secrets', home_path)
+end
+
+def editor_responses_path
+  File.expand_path('briefcase_editor_responses', SPEC_ROOT)
+end
+
+def create_home_directory
+  mkdir_p(home_path)
+end
+
+def cleanup_home_directory
+  rm_rf(home_path)
+end
+
+def create_git_repo
+  mkdir_p(File.join(dotfiles_path, '.git'))
+end
+
+def create_dotfiles_directory
+  mkdir_p(dotfiles_path)
+end
+
+def create_secrets(hash={})
+  File.open(secrets_path, "w") do |file|
+    file.write(hash.to_yaml)
+  end
+end
+
+def cleanup_dotfiles_directory
+  rm_rf(dotfiles_path)
+end
+
+def create_file(path, text='')
+  File.open(path, "w") do |file|
+    file.write(text)
+  end
+end
+
+def create_trackable_file(path)
+  create_file(path, path)
+end

data/spec/helpers/stubbing.rb

@@ -0,0 +1,25 @@
+def stub_editor_response(file, text)
+  response_file = file.gsub(/\//, '_')
+  mkdir_p(editor_responses_path)
+  File.open(File.join(editor_responses_path, response_file), 'w') do |file|
+    file.write(text)
+  end
+end
+
+def cleanup_editor_responses
+  rm_rf(editor_responses_path)
+end
+
+class Object
+  def stub(method_name, return_value=nil, &block)
+    (class << self; self; end).class_eval do
+      define_method method_name do |*args|
+        if block_given?
+          block.call(*args)
+        else
+          return_value
+        end
+      end
+    end
+  end
+end

data/spec/import_spec.rb

@@ -0,0 +1,145 @@
+require 'spec_helper'
+
+describe Briefcase::Commands::Import do
+
+  before do
+    create_home_directory
+
+    @original_path = File.join(home_path, '.test')
+    @destination_path = File.join(dotfiles_path, 'test')
+  end
+
+  after do
+    cleanup_home_directory
+    cleanup_dotfiles_directory
+    cleanup_editor_responses
+  end
+
+  it "creates a .dotfiles directory if it doesn't exist" do
+    create_trackable_file(@original_path)
+
+    run_command("import #{@original_path}") do |c|
+      c.response(/create one now?/, 'create')
+    end
+
+    output_must_contain(/Creating/)
+    output_must_contain(/Initialized/)
+    directory_must_exist(dotfiles_path)
+
+    directory_must_exist(File.join(dotfiles_path, '.git'))
+  end
+
+  it "does not create a .dotfiles directory when a users cancels" do
+    create_trackable_file(@original_path)
+
+    run_command("import #{@original_path}", 255) do |c|
+      c.response(/create one now?/, 'abort')
+    end
+
+    output_must_not_contain(/Creating/)
+    output_must_not_contain(/Initializing/)
+    directory_must_not_exist(dotfiles_path)
+  end
+
+  describe "with an existing dotfiles directory" do
+
+    before do
+      create_dotfiles_directory
+      create_git_repo
+    end
+
+    after do
+      cleanup_dotfiles_directory
+    end
+
+    it "does not import a nonexistent dotfile" do
+      run_command("import .test", 255)
+      output_must_contain(/does not exist/)
+    end
+
+    it "imports a dotfile" do
+      create_trackable_file(@original_path)
+
+      run_command("import #{@original_path}")
+
+      output_must_contain(/Importing/, /Moving/)
+      file_must_have_moved(@original_path, @destination_path)
+      symlink_must_exist(@original_path, @destination_path)
+    end
+
+    it "imports a redacted dotfile" do
+      redacted_path = File.join(dotfiles_path, 'test.redacted')
+      create_file @original_path, <<-TEXT
+setting: ABCDEFG
+TEXT
+
+      stub_editor_response redacted_path, <<-TEXT
+# Edit the file below, replacing and sensitive information to turn this:
+#
+#   password: superSecretPassword
+#
+# Into:
+#
+#   password: # briefcase(password)
+#
+########################################################################
+setting: # briefcase(token)
+TEXT
+
+      run_command("redact #{@original_path}")
+
+      output_must_contain(/Importing/, /Moving/, /Creating redacted version at/, /Storing secret value for key: token/)
+      secret_must_be_stored('test', 'token', 'ABCDEFG')
+      symlink_must_exist(@original_path, @destination_path)
+      file_must_not_match(redacted_path, 'replacing and sensitive information')
+      git_ignore_must_include(@destination_path)
+    end
+
+    describe "collision handling" do
+
+      before do
+        @relocated_path = File.join(dotfiles_path, 'test.old.1')
+        create_trackable_file(@original_path)
+        create_trackable_file(@destination_path)
+      end
+
+      it "renames an existing dotfile when importing a duplicate and instructed to replace it" do
+        run_command("import #{@original_path}") do |c|
+          c.response(/Do you want to replace it\?/, 'replace')
+        end
+
+        output_must_contain(/Moving/, /Symlinking/, /already exists as a dotfile/)
+        file_must_exist(@destination_path)
+        file_must_exist(@relocated_path)
+        symlink_must_exist(@original_path, @destination_path)
+      end
+
+      it "renames an existing duplicate dotfile when importing a duplicate and instructed to replace it" do
+        duplicate_path = File.join(dotfiles_path, 'test.old.2')
+        create_trackable_file(@relocated_path)
+
+        run_command("import #{@original_path}") do |c|
+          c.response(/Do you want to replace it\?/, 'replace')
+        end
+
+        file_must_have_moved(@destination_path, duplicate_path)
+        file_must_not_have_moved(@relocated_path)
+      end
+
+      it "does not modify an existing dotfile when instructed not to" do
+        run_command("import #{@original_path}", 255) do |c|
+          c.response(/Do you want to replace it\?/, 'abort')
+        end
+
+        output_must_contain(/already exists as a dotfile/)
+        output_must_not_contain(/Moving/, /Symlinking/)
+        file_must_not_have_moved(@original_path)
+        file_must_not_have_moved(@destination_path)
+        file_must_not_exist(@relocated_path)
+        symlink_must_not_exist(@original_path)
+      end
+
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'minitest/spec'
+# require 'turn/autorun/minitest'
+require 'minitest/mock'
+
+MiniTest::Unit.autorun
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'briefcase'
+
+require 'helpers/assertions'
+require 'helpers/files'
+require 'helpers/stubbing'
+require 'helpers/commands'

data/spec/sync_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Briefcase::Commands::Sync do
+
+  before do
+    create_home_directory
+    create_dotfiles_directory
+
+    @file_path = File.join(dotfiles_path, 'test')
+    @link_path = File.join(home_path, '.test')
+  end
+
+  after do
+    cleanup_home_directory
+    cleanup_dotfiles_directory
+  end
+
+  it "creates links to existing files" do
+    create_file(@file_path)
+
+    run_command("sync")
+
+    output_must_contain(/Synchronizing dotfiles/, /Symlinking/)
+
+    file_must_exist(@file_path)
+    symlink_must_exist(@link_path, @file_path)
+  end
+
+  it "does not create links to existing dynamic files" do
+    redacted_path = File.join(dotfiles_path, 'test.redacted')
+    dynamic_link_path = File.join(home_path, '.test.redacted')
+    create_file(redacted_path)
+
+    run_command("sync")
+
+    output_must_not_contain(/Symlinking/)
+    file_must_not_exist(dynamic_link_path)
+  end
+
+  it "handles finding real dotfiles where symlinks would be" do
+    file_path = File.join(home_path, '.test')
+    link_path = File.join(dotfiles_path, 'test')
+    create_file(file_path)
+    create_file(link_path)
+
+    run_command("sync")
+
+    output_must_not_contain(/Symlinking/)
+    output_must_contain(/skipping/)
+  end
+
+end