gitdocs 0.5.0.pre6 → 0.5.0.pre7

data/test/integration/full_sync_test.rb

@@ -1,19 +1,11 @@
+# -*- encoding : utf-8 -*-
+
 require File.expand_path('../test_helper', __FILE__)
 
 describe 'fully synchronizing repositories' do
   before do
     git_clone_and_gitdocs_add(git_init_remote, 'clone1', 'clone2', 'clone3')
-
-    # TODO: apply this configuration through the CLI in future
-    configuration = Gitdocs::Configuration.new
-    configuration.shares.each do |share|
-      share.update_attributes(polling_interval: 0.1, notification: false)
-    end
-
-    start_cmd = 'gitdocs start --debug --pid=gitdocs.pid --port 7777'
-    run(start_cmd, 15)
-    assert_success(true)
-    assert_partial_output('Started gitdocs', output_from(start_cmd))
+    start_daemon
   end
 
   it 'should sync new files' do

data/test/integration/share_management_test.rb

@@ -1,3 +1,5 @@
+# -*- encoding : utf-8 -*-
+
 require File.expand_path('../test_helper', __FILE__)
 
 describe 'Manage which shares are being watched' do
@@ -14,24 +16,71 @@ describe 'Manage which shares are being watched' do
     cmd = "gitdocs create local #{abs_remote_path} --pid=gitdocs.pid"
     run_simple(cmd, true, 15)
     assert_success(true)
-    assert_partial_output("Added path local to doc list", output_from(cmd))
+    assert_partial_output('Added path local to doc list', output_from(cmd))
   end
 
-  it 'should remove a share' do
+  it 'should update a share through the UI' do
     git_init_local
     gitdocs_add
+    start_daemon
+    visit('http://localhost:7777/')
+    click_link('Settings')
 
-    cmd = 'gitdocs rm local --pid=gitdocs.pid'
-    run_simple(cmd, true, 15)
-    assert_success(true)
-    assert_partial_output("Removed path local from doc list", output_from(cmd))
-  
-    gitdocs_status
-    assert_gitdocs_status_not_contain(abs_current_dir('local'))
+    within('#settings') do
+      within('#share-0') do
+        fill_in('share[0][polling_interval]', with: '0.2')
+        select('Fetch only', from: 'share[0][sync_type]')
+      end
+      click_button('Save')
+    end
+
+    # Allow the asynchronous portion of the update finish before checking
+    # the result.
+    sleep(1)
+
+    click_link('Settings')
+    within('#settings') do
+      within('#share-0') do
+        page.must_have_field('share[0][polling_interval]', with: '0.2')
+        page.must_have_field('share[0][sync_type]', with: 'fetch')
+      end
+    end
+  end
+
+  describe 'remove a share' do
+    before do
+      git_init_local
+      gitdocs_add
+    end
+
+    it 'through CLI' do
+      cmd = 'gitdocs rm local --pid=gitdocs.pid'
+      run_simple(cmd, true, 15)
+      assert_success(true)
+      assert_partial_output('Removed path local from doc list', output_from(cmd))
+
+      gitdocs_status
+      assert_gitdocs_status_not_contain(abs_current_dir('local'))
+    end
+
+    it 'through UI' do
+      start_daemon
+      visit('http://localhost:7777/')
+      click_link('Settings')
+
+      within('#settings') do
+        within('#share-0') { click_link('Delete') }
+
+        page.must_have_css('.share', count: 0)
+      end
+    end
   end
 
   it 'should clear all existing shares' do
-    ['local1', 'local2', 'local3'].each { |x| git_init_local(x) ; gitdocs_add(x) }
+    %w(local1 local2 local3).each do |path|
+      git_init_local(path)
+      gitdocs_add(path)
+    end
 
     cmd = 'gitdocs clear --pid=gitdocs.pid'
     run_simple(cmd, true, 15)

data/test/integration/status_test.rb

@@ -1,3 +1,5 @@
+# -*- encoding : utf-8 -*-
+
 require File.expand_path('../test_helper', __FILE__)
 
 describe 'CLI with display daemon and share status' do

data/test/integration/test_helper.rb

@@ -1,3 +1,5 @@
+# -*- encoding : utf-8 -*-
+
 require 'rubygems'
 require 'minitest/autorun'
 $LOAD_PATH.unshift File.expand_path('../../lib')
@@ -5,6 +7,18 @@ require 'gitdocs'
 require 'aruba'
 require 'aruba/api'
 require 'timeout'
+require 'capybara'
+require 'capybara_minitest_spec'
+require 'capybara/poltergeist'
+
+Capybara.app_host          = 'http://localhost:7777/'
+Capybara.default_driver    = :poltergeist
+Capybara.run_server        = false
+Capybara.default_wait_time = 20
+
+Capybara.register_driver :poltergeist do |app|
+  Capybara::Poltergeist::Driver.new(app, timeout: 20)
+end
 
 module MiniTest::Aruba
   class ArubaApiWrapper
@@ -43,6 +57,8 @@ end
 
 module Helper
   include MiniTest::Aruba
+  include Capybara::DSL
+  include Capybara::RSpecMatchers
 
   def before_setup
     super
@@ -50,24 +66,41 @@ module Helper
     ENV['TEST'] = nil
   end
 
+  def teardown
+    Capybara.reset_sessions!
+    Capybara.use_default_driver
+  end
+
   def after_teardown
     super
 
     terminate_processes!
     prep_for_fs_check do
-      next unless File.exists?('gitdocs.pid')
+      next unless File.exist?('gitdocs.pid')
 
       pid = IO.read('gitdocs.pid').to_i
       Process.kill('KILL', pid)
       begin
         Process.wait(pid)
-      rescue SystemCallError
+      rescue SystemCallError # rubocop:disable Lint/HandleExceptions
         # This means that the process is already gone.
         # Nothing to do.
       end
     end
   end
 
+  def start_daemon
+    configuration = Gitdocs::Configuration.new
+    configuration.shares.each do |share|
+      share.update_attributes(polling_interval: 0.1, notification: false)
+    end
+
+    start_cmd = 'gitdocs start --debug --pid=gitdocs.pid --port 7777'
+    run(start_cmd, 15)
+    assert_success(true)
+    assert_partial_output('Started gitdocs', output_from(start_cmd))
+  end
+
   # @overload abs_current_dir
   #   @return [String] absolute path for current_dir
   # @overload abs_current_dir(relative_path)
@@ -94,7 +127,7 @@ module Helper
 
   def wait_for_clean_workdir(path)
     dirty = true
-    Timeout.timeout(10) do
+    Timeout.timeout(20) do
       while dirty
         begin
           sleep(0.1)
@@ -116,7 +149,7 @@ module Helper
   def wait_for_exact_file_content(file, exact_content)
     in_current_dir do
       begin
-        Timeout.timeout(10) do
+        Timeout.timeout(20) do
           sleep(0.1) until File.exist?(file) && IO.read(file) == exact_content
         end
       rescue Timeout::Error
@@ -135,7 +168,7 @@ module Helper
   def wait_for_directory(path)
     in_current_dir do
       begin
-        Timeout.timeout(10) { sleep(0.1) until Dir.exist?(path) }
+        Timeout.timeout(20) { sleep(0.1) until Dir.exist?(path) }
       rescue Timeout::Error
         nil
       end
@@ -147,7 +180,7 @@ module Helper
   def wait_for_conflict_markers(path)
     in_current_dir do
       begin
-        Timeout.timeout(10) { sleep(0.1) if File.exist?(path) }
+        Timeout.timeout(20) { sleep(0.1) if File.exist?(path) }
       rescue Timeout::Error
         nil
       ensure
@@ -155,7 +188,7 @@ module Helper
       end
 
       begin
-        Timeout.timeout(10) { sleep(0.1) if Dir.glob("#{path} (*)").empty? }
+        Timeout.timeout(20) { sleep(0.1) if Dir.glob("#{path} (*)").empty? }
       rescue Timeout::Error
         nil
       ensure

data/test/unit/configuration_test.rb

@@ -0,0 +1,82 @@
+# -*- encoding : utf-8 -*-
+
+require File.expand_path('../test_helper', __FILE__)
+
+describe 'gitdocs configuration' do
+  before do
+    ENV['TEST'] = 'true'
+    ShellTools.capture { @config = Gitdocs::Configuration.new('/tmp/gitdocs') }
+  end
+
+  it 'has sensible default config root' do
+    assert_equal '/tmp/gitdocs', @config.config_root
+  end
+
+  it 'can retrieve empty shares' do
+    assert_equal [], @config.shares
+  end
+
+  it 'can have a path added' do
+    @config.add_path('/my/../my/path') # normalized test
+    assert_equal '/my/path', @config.shares.first.path
+    assert_equal 15.0, @config.shares.first.polling_interval
+  end
+
+  it 'can have a path removed' do
+    @config.add_path('/my/path')
+    @config.add_path('/my/path/2')
+    @config.remove_path('/my/../my/path/2') # normalized test
+    assert_equal ['/my/path'], @config.shares.map(&:path)
+  end
+
+  it 'can have a share removed by id' do
+    @config.add_path('/my/path')
+    @config.add_path('/my/path/2')
+
+    # Delete an index which exists
+    @config.remove_by_id(2).must_equal(true) # normalized test
+    assert_equal ['/my/path'], @config.shares.map(&:path)
+
+    # Try to delete an index which does not exist
+    @config.remove_by_id(5).must_equal(false) # normalized test
+    assert_equal ['/my/path'], @config.shares.map(&:path)
+  end
+
+  it 'can clear paths' do
+    @config.add_path('/my/path')
+    @config.add_path('/my/path/2')
+    @config.clear
+    assert_equal [], @config.shares.map(&:path)
+  end
+
+  describe '#update_all' do
+    before do
+      @config.add_path('/my/path')
+      @config.add_path('/my/path/2')
+      @config.add_path('/my/path/3')
+      @config.add_path('/my/path/4')
+      @config.add_path('/my/path/5')
+      @config.update_all(
+        'config' => { 'start_web_frontend' => false, 'web_frontend_port' => 9999 },
+        'share'  => {
+          '0' => { 'path' => '/my/path',    'polling_interval' => 42 },
+          '1' => { 'path' => '/my/path/2',  'polling_interval' => 66 },
+          '2' => { 'path' => '/my/path/3a', 'polling_interval' => 77 },
+          '3' => { 'path' => '',            'polling_interval' => 88 },
+          '4' => {                          'polling_interval' => 99 }
+        }
+      )
+    end
+    it { @config.shares.size.must_equal(5) }
+    it { @config.shares[0].path.must_equal('/my/path') }
+    it { @config.shares[0].polling_interval.must_equal(42) }
+    it { @config.shares[1].path.must_equal('/my/path/2') }
+    it { @config.shares[1].polling_interval.must_equal(66) }
+    it { @config.shares[2].path.must_equal('/my/path/3a') }
+    it { @config.shares[2].polling_interval.must_equal(77) }
+    it { @config.shares[3].path.must_equal('/my/path/4') }
+    it { @config.shares[3].polling_interval.must_equal(15) }
+    it { @config.shares[4].path.must_equal('/my/path/5') }
+    it { @config.shares[4].polling_interval.must_equal(15) }
+  end
+end

data/test/unit/notifier_test.rb

@@ -0,0 +1,165 @@
+# -*- encoding : utf-8 -*-
+require File.expand_path('../test_helper', __FILE__)
+
+describe Gitdocs::Notifier do
+  let(:notifier) { Gitdocs::Notifier.new(show_notifications) }
+
+  describe '#error' do
+    subject { Gitdocs::Notifier.error(:title, :message) }
+    before do
+      Gitdocs::Notifier.expects(:new).with(true).returns(notifier = mock)
+      notifier.expects(:error).with(:title, :message)
+    end
+    it { subject }
+  end
+
+  describe '#info' do
+    subject { notifier.info('title', 'message') }
+
+    describe 'without notifications' do
+      let(:show_notifications) { false }
+      before { notifier.expects(:puts).with('title: message') }
+      it { subject }
+    end
+
+    describe 'with notifications' do
+      let(:show_notifications) { true }
+      before do
+        Guard::Notifier.expects(:turn_on)
+        Guard::Notifier.expects(:notify)
+          .with(
+            'message',
+            title: 'title',
+            image: File.expand_path('../../../lib/img/icon.png', __FILE__)
+          )
+      end
+      it { subject }
+    end
+  end
+
+  describe '#warn' do
+    subject { notifier.warn('title', 'message') }
+
+    describe 'without notifications' do
+      let(:show_notifications) { false }
+      before { Kernel.expects(:warn).with('title: message') }
+      it { subject }
+    end
+
+    describe 'with notifications' do
+      let(:show_notifications) { true }
+      before do
+        Guard::Notifier.expects(:turn_on)
+        Guard::Notifier.expects(:notify).with('message', title: 'title')
+      end
+      it { subject }
+    end
+  end
+
+  describe '#error' do
+    subject { notifier.error('title', 'message') }
+
+    describe 'without notifications' do
+      let(:show_notifications) { false }
+      before { Kernel.expects(:warn).with('title: message') }
+      it { subject }
+    end
+
+    describe 'with notifications' do
+      let(:show_notifications) { true }
+      before do
+        Guard::Notifier.expects(:turn_on)
+        Guard::Notifier.expects(:notify).with('message', title: 'title', image: :failure)
+      end
+      it { subject }
+    end
+  end
+
+  describe '#merge_notification' do
+    subject { notifier.merge_notification(result, 'root_path') }
+
+    let(:show_notifications) { false }
+
+    describe 'with no changes' do
+      before do
+        # Ensure that the notification methods are not called.
+        notifier.stubs(:warn).raises
+        notifier.stubs(:info).raises
+        notifier.stubs(:error).raises
+      end
+      describe('with nil')        { let(:result) { nil }        ; it { subject } }
+      describe('with no_remote')  { let(:result) { :no_remote } ; it { subject } }
+      describe('with no changes') { let(:result) { {} }         ; it { subject } }
+    end
+
+    describe 'with changes' do
+      let(:result)  { { 'Alice' => 1, 'Bob' => 3 } }
+      before do
+        notifier.expects(:info).with(
+          'Updated with 4 changes',
+          "In root_path:\n* Alice (1 change)\n* Bob (3 changes)"
+        )
+      end
+      it { subject }
+    end
+
+    describe 'with conflicts' do
+      let(:result)  { ['file'] }
+      before do
+        notifier.expects(:warn).with(
+          'There were some conflicts',
+          '* file'
+        )
+      end
+      it { subject }
+    end
+
+    describe 'with anything else' do
+      let(:result) { 'error' }
+      before do
+        notifier.expects(:error).with(
+          'There was a problem synchronizing this gitdoc',
+          "A problem occurred in root_path:\nerror"
+        )
+      end
+      it { subject }
+    end
+  end
+
+  describe '#push_notification' do
+    subject { notifier.push_notification(result, 'root_path') }
+
+    let(:show_notifications) { false }
+
+    describe('with nil')       { let(:result) { nil }        ; it { subject } }
+    describe('with no_remote') { let(:result) { :no_remote } ; it { subject } }
+    describe('with nothing')   { let(:result) { :nothing }   ; it { subject } }
+
+    describe 'with changes' do
+      let(:result)  { { 'Alice' => 1, 'Bob' => 3 } }
+      before do
+        notifier.expects(:info)
+          .with('Pushed 4 changes', 'root_path has been pushed')
+      end
+      it { subject }
+    end
+
+    describe 'with conflict' do
+      let(:result) { :conflict }
+      before do
+        notifier.expects(:warn)
+          .with('There was a conflict in root_path, retrying', '')
+      end
+      it { subject }
+    end
+
+    describe 'with anything else' do
+      let(:result) { 'error' }
+      before do
+        notifier.expects(:error)
+          .with('BAD Could not push changes in root_path', 'error')
+      end
+      it { subject }
+    end
+  end
+end