tetra 0.48.0 → 0.49.0

data/lib/tetra/facades/process_runner.rb

@@ -6,9 +6,9 @@ module Tetra
     include Logging
 
     # runs an external executable and returns its output as a string
-    # raises ExecutionFailed if the exit status is not 0 (override with fail_on_error)
+    # raises ExecutionFailed if the exit status is not 0
     # optionally echoes the executable's output/error to standard output/error
-    def run(commandline, echo = false, fail_on_error = true)
+    def run(commandline, echo = false)
       log.debug "running `#{commandline}`"
 
       out_recorder = echo ? RecordingIO.new(STDOUT) : RecordingIO.new
@@ -19,14 +19,15 @@ module Tetra
       log.debug "`#{commandline}` exited with status #{status}"
 
       if status != 0
-        if fail_on_error
-          log.warn("`#{commandline}` failed, status #{status}")
-          log.warn("standard output follows")
-          log.warn(out_recorder.record)
-          log.warn("standard error follows")
-          log.warn(err_recorder.record)
-          fail ExecutionFailed.new(commandline, status)
+        log.warn("`#{commandline}` failed with status #{status}")
+        out = out_recorder.record
+        err = err_recorder.record
+        if out != "" || err != ""
+          log.warn("Output follows:")
+          log.warn(out) unless out == ""
+          log.warn(err) unless err == ""
         end
+        fail ExecutionFailed.new(commandline, status)
       end
 
       out_recorder.record

data/lib/tetra/packages/kit_package.rb

@@ -8,14 +8,13 @@ module Tetra
     include Speccable
 
     attr_reader :name
-    attr_reader :version
+    def_delegator :@project, :version
     def_delegator :@project, :name, :project_name
 
     def initialize(project)
       @project = project
 
       @name = "#{project.name}-kit"
-      @version = "#{project.version}"
     end
 
     def to_archive

data/lib/tetra/packages/package.rb

@@ -21,7 +21,7 @@ module Tetra
     def initialize(project, pom_path = nil, filter = nil)
       @project = project
       @kit = Tetra::KitPackage.new(project)
-      @pom = pom_path.nil? ? nil : Tetra::Pom.new(pom_path)
+      @pom = Tetra::Pom.new(pom_path)
       @filter = filter
     end
 

data/lib/tetra/packages/scriptable.rb

@@ -28,7 +28,7 @@ module Tetra
         FileUtils.mkdir_p(result_dir)
         result_path = File.join(result_dir, "build.sh")
         conflict_count = project.merge_new_content(new_content, result_path, "Build script generated",
-                                                   "generate_build_script")
+                                                   "script")
 
         [result_path, conflict_count]
       end

data/lib/tetra/packages/speccable.rb

@@ -18,7 +18,7 @@ module Tetra
         new_content = generate(template_spec_name, binding)
         label = "Spec for #{name} generated"
         conflict_count = project.merge_new_content(new_content, spec_path,
-                                                   label, "generate_#{name}_spec")
+                                                   label, "#{name}-spec")
         [spec_path, conflict_count]
       end
     end

data/lib/tetra/pom.rb

@@ -4,7 +4,11 @@ module Tetra
   # encapsulates a pom.xml file
   class Pom
     def initialize(filename)
-      @doc = Nokogiri::XML(open(filename).read)
+      @doc = Nokogiri::XML(
+        if filename && File.file?(filename)
+          open(filename).read
+        end
+      )
       @doc.remove_namespaces!
     end
 

data/lib/tetra/project.rb

@@ -5,6 +5,9 @@ module Tetra
   class Project
     include Logging
 
+    # path of the project template files
+    TEMPLATE_PATH = File.join(File.dirname(__FILE__), "..", "template")
+
     attr_reader :full_path
 
     def initialize(path)
@@ -17,7 +20,7 @@ module Tetra
     end
 
     def version
-      latest_tag_count(:dry_run_finished)
+      @git.latest_id("tetra: dry-run-finished")
     end
 
     def packages_dir
@@ -44,31 +47,43 @@ module Tetra
     end
 
     # inits a new project directory structure
-    def self.init(dir)
+    def self.init(dir, include_bundled_software = true)
       Dir.chdir(dir) do
         Tetra::Git.new(".").init
 
         FileUtils.mkdir_p("src")
         FileUtils.mkdir_p("kit")
 
-        # populate the project with templates and take a snapshot
+        # populate the project with templates and commit it
         project = Project.new(".")
 
-        template_path = File.join(File.dirname(__FILE__), "..", "template")
+        project.template_files(include_bundled_software).each do |source, destination|
+          FileUtils.cp_r(File.join(TEMPLATE_PATH, source), destination)
+        end
 
-        templates = {
-          "kit" => ".",
-          "packages" => ".",
-          "src" => ".",
-          "gitignore" => ".gitignore"
-        }
+        project.commit_whole_project("Template files added")
+      end
+    end
 
-        templates.each do |source, destination|
-          FileUtils.cp_r(File.join(template_path, source), destination)
+    # returns a hash that maps filenames that should be copied from TEMPLATE_PATH
+    # to the value directory
+    def template_files(include_bundled_software)
+      result = {
+        "kit" => ".",
+        "packages" => ".",
+        "src" => ".",
+        "gitignore" => ".gitignore"
+      }
+
+      if include_bundled_software
+        Dir.chdir(TEMPLATE_PATH) do
+          Dir.glob(File.join("bundled", "*")).each do |file|
+            result[file] = "kit"
+          end
         end
-
-        project.take_snapshot("Template files added", :init)
       end
+
+      result
     end
 
     # starts a dry running phase: files added to kit/ will be added
@@ -79,24 +94,25 @@ module Tetra
 
       current_directory = Pathname.new(Dir.pwd).relative_path_from(Pathname.new(@full_path))
 
-      take_snapshot("Dry-run started", :dry_run_started, current_directory)
+      commit_whole_project("Dry-run started", "tetra: dry-run-started: #{current_directory}")
       true
     end
 
     # returns true iff we are currently dry-running
     def dry_running?
-      latest_tag_count(:dry_run_started) > latest_tag_count(:dry_run_finished)
+      latest_comment = @git.latest_comment("tetra: dry-run-")
+      !latest_comment.nil? && !(latest_comment =~ /tetra: dry-run-finished/)
     end
 
     # ends a dry-run assuming a successful build
     # reverts sources and updates output file lists
     def finish
       if dry_running?
-        take_snapshot("Changes during dry-run", :dry_run_changed)
+        commit_whole_project("Changes during dry-run", "tetra: dry-run-changed")
 
-        @git.revert_whole_directory("src", latest_tag(:dry_run_started))
+        @git.revert_whole_directory("src", @git.latest_id("tetra: dry-run-started"))
 
-        take_snapshot("Dry run finished", :dry_run_finished)
+        commit_whole_project("Dry run finished", "tetra: dry-run-finished")
         return true
       end
       false
@@ -106,17 +122,16 @@ module Tetra
     # reverts the whole project directory
     def abort
       if dry_running?
-        @git.revert_whole_directory(".", latest_tag(:dry_run_started))
-        @git.delete_tag(latest_tag(:dry_run_started))
+        @git.revert_whole_directory(".", @git.latest_id("tetra: dry-run-started"))
+        @git.undo_last_commit
         return true
       end
       false
     end
 
-    # takes a revertable snapshot of this project
-    def take_snapshot(message, tag_prefix, tag_message = nil)
-      # rename all .gitignore files by default as
-      # they prevent snapshotting
+    # commits all files in the project
+    def commit_whole_project(*comments)
+      # rename all .gitignore files that might have slipped in
       from_directory("src") do
         Find.find(".") do |file|
           next unless file =~ /\.gitignore$/
@@ -125,58 +140,46 @@ module Tetra
         end
       end
 
-      @git.commit_whole_directory(message, next_tag(tag_prefix), tag_message)
+      @git.commit_whole_directory(comments.join("\n\n"))
     end
 
-    # replaces content in path with new_content, takes a snapshot using
-    # snapshot_message and tag_prefix and 3-way merges new and old content
-    # with a previous snapshotted file same path tag_prefix, if it exists.
+    # replaces content in path with new_content, commits using
+    # comment and 3-way merges new and old content with the previous
+    # version of file of the same kind, if it exists.
     # returns the number of conflicts
-    def merge_new_content(new_content, path, snapshot_message, tag_prefix)
+    def merge_new_content(new_content, path, comment, kind)
       from_directory do
-        log.debug "merging new content to #{path} with prefix #{tag_prefix}"
+        log.debug "merging new content to #{path} of kind #{kind}"
         already_existing = File.exist?(path)
 
+        generated_comment = "tetra: generated-#{kind}"
+        whole_comment = [comment, generated_comment].join("\n\n")
+
         if already_existing
-          if latest_tag_count(tag_prefix) == 0
-            log.debug "saving untagged version"
-            @git.commit_file(path, snapshot_message, next_tag(tag_prefix))
+          unless @git.latest_id(generated_comment)
+            log.debug "committing new file"
+            @git.commit_file(path, whole_comment)
           end
           log.debug "moving #{path} to #{path}.tetra_user_edited"
-          File.rename path, "#{path}.tetra_user_edited"
+          File.rename(path, "#{path}.tetra_user_edited")
         end
 
-        previous_tag = latest_tag(tag_prefix)
+        previous_id = @git.latest_id(generated_comment)
 
         File.open(path, "w") { |io| io.write(new_content) }
-        log.debug "taking snapshot with new content: #{snapshot_message}"
-        @git.commit_file(path, snapshot_message, next_tag(tag_prefix))
+        log.debug "committing new content: #{comment}"
+        @git.commit_file(path, whole_comment)
 
         if already_existing
           # 3-way merge
-          conflict_count = @git.merge_with_tag("#{path}", "#{path}.tetra_user_edited", previous_tag)
-          File.delete "#{path}.tetra_user_edited"
+          conflict_count = @git.merge_with_id("#{path}", "#{path}.tetra_user_edited", previous_id)
+          File.delete("#{path}.tetra_user_edited")
           return conflict_count
         end
         return 0
       end
     end
 
-    # returns the tag with maximum count for a given tag prefix
-    def latest_tag(prefix)
-      "#{prefix}_#{latest_tag_count(prefix)}"
-    end
-
-    # returns the maximum tag count for a given tag prefix
-    def latest_tag_count(prefix)
-      @git.get_tag_maximum_suffix(prefix)
-    end
-
-    # returns the next tag for a given tag prefix
-    def next_tag(prefix)
-      "#{prefix}_#{latest_tag_count(prefix) + 1}"
-    end
-
     # runs a block from the project directory or a subdirectory
     def from_directory(subdirectory = "")
       Dir.chdir(File.join(@full_path, subdirectory)) do
@@ -186,19 +189,15 @@ module Tetra
 
     # returns the latest dry run start directory
     def latest_dry_run_directory
-      @git.get_message(latest_tag(:dry_run_started))
+      @git.latest_comment("tetra: dry-run-started")[/tetra: dry-run-started: (.*)$/, 1]
     end
 
-    # returns a list of files produced during dry-runs
+    # returns a list of files produced during the last dry-run
     def produced_files
-      dry_run_count = latest_tag_count(:dry_run_changed)
-      log.debug "Getting produced files from #{dry_run_count} dry runs"
-      if dry_run_count >= 1
-        (1..dry_run_count).map do |i|
-          @git.changed_files_between("dry_run_started_#{i}", "dry_run_changed_#{i}", "src")
-        end
-          .flatten
-          .uniq
+      start_id = @git.latest_id("tetra: dry-run-started")
+      end_id = @git.latest_id("tetra: dry-run-changed")
+      if !start_id.nil? && !end_id.nil?
+        @git.changed_files_between(start_id, end_id, "src")
           .sort
           .map { |file| Pathname.new(file).relative_path_from(Pathname.new("src")).to_s }
       else

data/lib/tetra/version.rb

@@ -2,5 +2,5 @@
 
 # base module for tetra
 module Tetra
-  VERSION = "0.48.0"
+  VERSION = "0.49.0"
 end

data/spec/lib/built_package_spec.rb

@@ -50,7 +50,7 @@ describe Tetra::Package do
         expect(spec_lines).to include("License:        The Apache Software License, Version 2.0\n")
         expect(spec_lines).to include("Summary:        Nailgun is a client, protocol, and server for running Java\n")
         expect(spec_lines).to include("Url:            http://martiansoftware.com/nailgun\n")
-        expect(spec_lines).to include("BuildRequires:  test-project-kit == 2\n")
+        expect(spec_lines).to include("BuildRequires:  test-project-kit == #{@project.version}\n")
         expect(spec_lines).to include("Provides:       mvn(com.martiansoftware:nailgun-all) == 0.9.1\n")
         expect(spec_lines).to include("cp -a out/test3.jar %{buildroot}%{_javadir}/test3.jar\n")
       end

data/spec/lib/git_spec.rb

@@ -15,7 +15,7 @@ describe Tetra::Git do
     FileUtils.rm_rf(@git_path)
   end
 
-  describe "#init"  do
+  describe "#init" do
     it "complains if a double initialization is attempted" do
       expect do
         @git.init
@@ -23,41 +23,33 @@ describe Tetra::Git do
     end
   end
 
-  describe "#commit_whole_directory" do
-    it "commits all contents of a directory to git for later use" do
+  describe "#latest_id" do
+    it "does not find a commit with a non-existing comment" do
       Dir.chdir(@git_path) do
-        File.open("file1", "w") do |file|
-          file.write "test"
-        end
-
-        @git.commit_whole_directory("test", :test)
-
-        files = `git ls-tree --name-only -r HEAD`.split("\n")
-
-        expect(files).to include("file1")
+        @git.commit_file(".", "initial commit")
+        expect(@git.latest_id("tetra: test")).to be_nil
+      end
+    end
+    it "finds a commit with a certain comment" do
+      Dir.chdir(@git_path) do
+        @git.commit_file(".", "tetra: test")
+        expect(@git.latest_id("tetra: test")).to eq `git rev-parse HEAD`.strip
       end
     end
   end
 
-  describe "#changed_files_since"  do
-    it "lists files changed since a tetra tag" do
+  describe "#commit_whole_directory" do
+    it "commits all contents of a directory to git for later use" do
       Dir.chdir(@git_path) do
         File.open("file1", "w") do |file|
           file.write "test"
         end
 
-        @git.commit_whole_directory("test", :test_start)
-
-        File.open("file2", "w") do |file|
-          file.write "test"
-        end
-
-        @git.commit_whole_directory("test end", :test_end)
+        @git.commit_whole_directory("test")
 
-        files = @git.changed_files_since(:test_start)
+        files = `git ls-tree --name-only -r HEAD`.split("\n")
 
-        expect(files).not_to include("file1")
-        expect(files).to include("file2")
+        expect(files).to include("file1")
       end
     end
   end
@@ -69,7 +61,7 @@ describe Tetra::Git do
           file.write "test"
         end
 
-        @git.commit_whole_directory("test", :test_start)
+        @git.commit_whole_directory("test\ntetra: test_start")
 
         File.open("file2", "w") do |file|
           file.write "test"
@@ -79,15 +71,18 @@ describe Tetra::Git do
           file.write "test"
         end
 
-        @git.commit_whole_directory("test", :test_end)
+        @git.commit_whole_directory("test\ntetra: test_end")
 
         File.open("file4", "w") do |file|
           file.write "test"
         end
 
-        @git.commit_whole_directory("test", :test_after)
+        @git.commit_whole_directory("test\ntetra: test_after")
+
+        start_id = @git.latest_id("tetra: test_start")
+        end_id = @git.latest_id("tetra: test_end")
 
-        files = @git.changed_files_between(:test_start, :test_end, "subdir")
+        files = @git.changed_files_between(start_id, end_id, "subdir")
 
         expect(files).not_to include("file1")
         expect(files).not_to include("file2")

data/spec/lib/project_spec.rb

@@ -3,16 +3,26 @@
 require "spec_helper"
 
 describe Tetra::Project do
-  before(:each) do
-    @project_path = File.join("spec", "data", "test-project")
-    Dir.mkdir(@project_path)
+  include Tetra::Mockers
 
-    Tetra::Project.init(@project_path)
-    @project = Tetra::Project.new(@project_path)
+  before(:each) do
+    create_mock_project
   end
 
   after(:each) do
-    FileUtils.rm_rf(@project_path)
+    delete_mock_project
+  end
+
+  describe "version"  do
+    it "returns no project version in case no dry-run happened" do
+      expect(@project.version).to be_nil
+    end
+
+    it "returns a project version after dry-run" do
+      @project.dry_run
+      @project.finish
+      expect(@project.version).to be
+    end
   end
 
   describe "#project?"  do
@@ -41,6 +51,16 @@ describe Tetra::Project do
     end
   end
 
+  describe "#template_files" do
+    it "returns the list of template files without bundles" do
+      expect(@project.template_files(false)).to include("kit" => ".")
+    end
+
+    it "returns the list of template files with bundles" do
+      expect(@project.template_files(true)).to include("bundled/apache-ant-1.9.4" => "kit")
+    end
+  end
+
   describe "#init" do
     it "inits a new project" do
       kit_path = File.join(@project_path, "kit")
@@ -63,7 +83,7 @@ describe Tetra::Project do
     end
   end
 
-  describe "#take_snapshot" do
+  describe "#commit_whole_project" do
     it "commits the project contents to git for later use" do
       @project.from_directory do
         FileUtils.touch(File.join("kit", "test"))
@@ -73,13 +93,12 @@ describe Tetra::Project do
           file.write "file"
         end
 
-        @project.take_snapshot("test", :revertable)
+        @project.commit_whole_project("test")
 
         files = `git ls-tree --name-only -r HEAD`.split("\n")
         expect(files).to include("src/.gitignore_disabled_by_tetra")
 
         expect(`git rev-list --all`.split("\n").length).to eq 2
-        expect(@project.latest_tag(:revertable)).to eq "revertable_1"
       end
     end
   end
@@ -133,7 +152,7 @@ describe Tetra::Project do
       expect(@project.dry_running?).to be_falsey
 
       @project.from_directory do
-        expect(`git rev-list --all`.split("\n").length).to eq 2
+        expect(`git rev-list --all`.split("\n").length).to eq 1
         expect(File.read("src/test")).to eq "A"
         expect(File.exist?("src/test2")).to be_falsey
 
@@ -159,7 +178,6 @@ describe Tetra::Project do
         expect(@project.dry_running?).to be_truthy
         expect(`git rev-list --all`.split("\n").length).to eq 2
         expect(`git diff-tree --no-commit-id --name-only -r HEAD`.split("\n")).to include("src/test")
-        expect(`git cat-file tag tetra_dry_run_started_1 | tail -1`).to include("src")
       end
     end
   end
@@ -184,9 +202,9 @@ describe Tetra::Project do
       expect(@project.finish).to be_truthy
 
       list = @project.produced_files
-      expect(list).to include("added_in_first_dry_run")
       expect(list).to include("added_in_second_dry_run")
 
+      expect(list).not_to include("added_in_first_dry_run")
       expect(list).not_to include("added_outside_dry_run")
       expect(list).not_to include("added_outside_directory")
     end