cir 0.1

data/lib/cir/stored_file.rb

@@ -0,0 +1,41 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Cir
+  ##
+  # Represents metadata about stored file.
+  class StoredFile
+
+    ##
+    # Full file path of the original file location
+    attr :file_path
+
+    ##
+    # Location in the repository with stored and versioned copy of the file
+    attr :repository_location
+
+    ##
+    # Constructor that will optionally populate attributes
+    def initialize(attrs = {})
+      attrs.each do |attr, value|
+        instance_variable_set "@#{attr}", value
+      end
+    end
+
+    ##
+    # Generate diff using DiffManager
+    def diff
+      Cir::DiffManager.create(repository_location, file_path)
+    end
+  end
+end

data/lib/cir/version.rb

@@ -0,0 +1,17 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+module Cir
+  ##
+  # Version of Cir
+  VERSION = "0.1"
+end # module Cir

data/test/cir_test_case.rb

@@ -0,0 +1,81 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require 'cir'
+require 'tmpdir'
+require 'test/unit'
+require 'fileutils'
+
+##
+# Parent test case that will contain shared functionality that we need
+# across various test cases.
+class CirTestCase < Test::Unit::TestCase
+
+  ##
+  # Prepare each test, currently:
+  # * Forward stderr and stdout to /dev/null
+  # * Prepare working directory (in tmp space)
+  def setup
+    # Create working directory
+    @workDir = Dir.mktmpdir(["cir_test_", "_#{self.class.name}"])
+    @repoDir = "#{@workDir}/repo"
+
+    # Forward stderr/stdout to /dev/null to not mess with test output
+    @original_stderr = $stderr
+    @original_stdout = $stdout    
+    $stderr = File.open(File::NULL, "w")
+    $stdout = File.open(File::NULL, "w")
+  end
+
+  ##
+  # Undo all the changes we did in #setup
+  def teardown
+    # Remove forwarding of stderr/stdout to /dev/null
+    $stderr = @original_stderr
+    $stdout = @original_stdout
+
+    # Cleaning up working directory
+    FileUtils.rm_rf(@workDir, secure: true)
+  end
+
+  ## 
+  # Create new file with given file name inside the work directory
+  # and return absolute path to the created file.
+  def create_file(fileName, content)
+    full_path = "#{@workDir}/#{fileName}"
+    File.open(full_path, 'w') { |f| f.write(content) }
+    File.expand_path(full_path)
+  end
+
+  ## 
+  # Initialize Cir::Repository inside @repoDir and persist that inside
+  # @repo variable (e.g. we have max 1 repo per test instance).
+  def init_repo
+    Cir::Repository.create(@repoDir)
+    @repo = Cir::Repository.new(@repoDir)
+  end
+
+  ##
+  # Initialize only git repository (no metadata) and persist that inside
+  # @repo variable.
+  def init_git_repo
+    @repo = Cir::GitRepository.create(@repoDir)
+  end
+
+  ##
+  # Asserts if given file have been correctly updated in the git working
+  # directory.
+  def assert_file_in_repo(file)
+    diff = Cir::DiffManager.create(file, "#{@repDir}/#{file}")
+    assert_false diff.changed?
+  end
+end

data/test/test_diff_manager.rb

@@ -0,0 +1,32 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require 'cir_test_case'
+
+class DiffManagerTest < CirTestCase
+
+  def test_create
+    # Test files
+    file_a = create_file("a.file", "A")
+    file_b = create_file("b.file", "A")
+    file_c = create_file("c.file", "B")
+
+    # Same content
+    diff = Cir::DiffManager.create(file_a, file_b)
+    assert_false diff.changed?
+
+    # Different content
+    diff = Cir::DiffManager.create(file_a, file_c)
+    assert diff.changed?
+  end
+
+end

data/test/test_git_repository.rb

@@ -0,0 +1,88 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require 'tmpdir'
+require 'cir_test_case'
+
+class GitRepositoryTest < CirTestCase
+
+  def test_create_already_exists
+    assert_raise Cir::Exception::RepositoryExists do
+      Cir::GitRepository.create(@workDir)
+    end
+  end
+
+  def test_create
+    Cir::GitRepository.create(@repoDir)
+    assert Dir.exists? "#{@repoDir}/.git"
+  end
+
+  def test_add_file_and_commit
+    init_git_repo
+
+    create_file("repo/a.file", "Content")
+    create_file("repo/b.file", "Content")
+
+    @repo.add_file "a.file"
+    @repo.add_file "b.file"
+    @repo.commit
+
+    ruggedRepo = Rugged::Repository.new(@repoDir)
+    master = ruggedRepo.branches.first
+    assert_equal "master", master.name
+    assert_not_nil master.target
+
+    assert_match "a.file", master.target.message
+    assert_match "b.file", master.target.message
+
+    tree = master.target.tree
+    assert_not_nil tree
+    assert_equal 2, tree.count
+    assert_not_nil tree['a.file']
+    assert_not_nil tree['b.file']
+  end
+
+  def test_remove_file_and_commit
+    init_git_repo
+
+    ruggedRepo = Rugged::Repository.new(@repoDir)
+
+    create_file("repo/a.file", "Content")
+    @repo.add_file "a.file"
+    @repo.commit
+    assert_equal 1, ruggedRepo.branches.first.target.tree.count
+
+    @repo.remove_file("a.file")
+    @repo.commit
+    assert_equal 0, ruggedRepo.branches.first.target.tree.count
+  end
+
+  def test_commit_message
+    init_git_repo
+
+    ruggedRepo = Rugged::Repository.new(@repoDir)
+
+    # Default commit message starts with "Affected files"
+    create_file("repo/a.file", "Content")
+    @repo.add_file "a.file"
+    @repo.commit
+    assert_match "Affected files", ruggedRepo.branches.first.target.message
+
+    # Which can be overridden to arbitrary text
+    @repo.remove_file "a.file"
+    @repo.commit("My message")
+    assert_match "My message", ruggedRepo.branches.first.target.message
+  end
+
+
+end
+

data/test/test_repository.rb

@@ -0,0 +1,163 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require 'tmpdir'
+require 'cir_test_case'
+
+class RepositoryTest < CirTestCase 
+
+  def test_create_already_exists
+    assert_raise Cir::Exception::RepositoryExists do
+      Cir::Repository.create(@workDir)
+    end
+  end
+
+  def test_create
+    init_repo
+
+    fileList = "#{@repoDir}/cir.file_list.yml"
+
+    assert File.exists? fileList
+    yaml = YAML::Store.new(fileList)
+
+    assert_equal(1, yaml.transaction { yaml[:version] })
+    assert_equal({}, yaml.transaction { yaml[:files] })
+  end
+
+
+  def test_register
+    init_repo
+
+    # Prepare test file
+    test_file = create_file("A", "Input data")
+
+    # Register in repository - we'll use not a final path to make sure that repository will correctly resolve it
+    @repo.register ["#{File.dirname(test_file)}/./#{File.basename(test_file)}"]
+
+    # Which should create entity in the repository
+    yaml = YAML::Store.new(@repoDir + '/cir.file_list.yml')
+    result = yaml.transaction { yaml[:files][test_file] }
+    assert_not_nil result
+    assert_equal({}, result)
+
+    # And the file should also exists in the working directory
+    assert File.exists?("#{@repoDir}/#{test_file}")
+
+    # Registering again should fail
+    assert_raise Cir::Exception::AlreadyRegistered do
+      @repo.register [test_file]
+    end
+  end
+
+  def test_registered
+    init_repo
+
+    test_file = create_file("A", "Input data")
+
+    @repo.register [test_file]
+
+    assert @repo.registered?(test_file)
+    assert_false @repo.registered?("/blah")
+  end
+
+  def test_deregister
+    init_repo
+
+    # Prepare test file
+    test_file = create_file("A", "Input data")
+
+    # Register in repository
+    @repo.register [test_file]
+    assert @repo.registered? test_file
+
+    # Deregister the file now
+    @repo.deregister [test_file]
+
+    assert_false @repo.registered? test_file
+    assert_false File.exists?("#{@repoDir}/#{test_file}")
+
+    # Deregister of not registered file should raise an exception
+    assert_raise(Cir::Exception::NotRegistered) { @repo.deregister ["X"]}
+  end
+
+  def test_status
+    init_repo
+
+    test_file_a = create_file("A", "data")
+    test_file_b = create_file("B", "data")
+    @repo.register [test_file_a, test_file_b]
+
+    # Everything
+    status = @repo.status
+    assert_not_nil status
+    assert_equal status.size, 2
+
+    # Not registered file
+    assert_raise(Cir::Exception::NotRegistered) { @repo.status ["X"] }
+
+    # One specific file
+    status = @repo.status [test_file_a]
+    assert_not_nil status
+    assert_equal status.size, 1
+  end
+
+  def test_update
+    init_repo
+
+    test_file = create_file("A", "data")
+    @repo.register [test_file]
+
+    # Update non existing file
+    assert_raise(Cir::Exception::NotRegistered) { @repo.update ["X"] }
+
+    # Updating via "all"
+    create_file("A", "New data")
+    @repo.update
+    assert_file_in_repo test_file
+
+    # Updating via "given file"
+    create_file("A", "Newer data")
+    @repo.update
+    assert_file_in_repo test_file
+  end
+
+  def test_restore
+    init_repo
+
+    test_file = create_file("A", "data")
+    @repo.register [test_file]
+
+    # Restore non existing file
+    assert_raise(Cir::Exception::NotRegistered) { @repo.restore ["X"] }
+
+    # Restoring non-existing file via "all"
+    FileUtils.rm test_file
+    @repo.restore
+    assert_file_in_repo test_file
+
+    # Restore non-existing file specifically by file name
+    FileUtils.rm test_file
+    @repo.restore([test_file])
+    assert_file_in_repo test_file
+
+    # Restoring via "all"
+    create_file("A", "New data")
+    @repo.restore(nil, true)
+    assert_file_in_repo test_file
+
+    # Restore given file
+    create_file("A", "Newer data")
+    @repo.restore([test_file])
+    assert_file_in_repo test_file
+  end
+
+end

data/test/test_stored_file.rb

@@ -0,0 +1,23 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require 'cir_test_case'
+
+class StoredFileTest < CirTestCase
+
+  def test_initialize
+    file = Cir::StoredFile.new file_path: "/home/jarcec/", repository_location: "location" 
+    assert_equal file.file_path, "/home/jarcec/"
+    assert_equal file.repository_location, "location"
+  end
+
+end