tetra 0.49.0 → 0.50.0

data/.rubocop.yml

@@ -11,10 +11,10 @@ AbcSize:
   Max: 50
 
 CyclomaticComplexity:
-  Max: 10
+  Max: 20
 
 PerceivedComplexity:
-  Max: 15
+  Max: 20
 
 StringLiterals:
   EnforcedStyle: double_quotes

data/SPECIAL_CASES.md

@@ -4,32 +4,44 @@
 
 If your build fails for whatever reason, abort it with `tetra finish abort`. `tetra` will restore all project files as they were before build.
 
-## Manual changes to generated files
+## Generating files multiple times
 
-You can do any manual changes to spec and build.sh files and regenerate them later, `tetra` will reconcile changes with a [three-way merge](http://en.wikipedia.org/wiki/Three-way_merge#Three-way_merge) and alert about any conflicts. You can generate single files with the following commands:
+You can edit any file generated by tetra - regenerating it later will not overwrite your changes.
+
+`tetra` will try to reconcile your edits with a [three-way merge](http://en.wikipedia.org/wiki/Three-way_merge#Three-way_merge) - if that fails you will be warned about any conflicts.
+
+You can generate single files with the following commands:
 
 * `tetra generate-script`: (re)generates the `build.sh` file from the latest bash history (assumes `tetra dry-run start` and `tetra dry-run finish` have been used);
 * `tetra generate-archive`: (re)generates the package tarball;
 * `tetra generate-spec`: (re)generates the package spec;
 * `tetra generate-kit`: (re)generates the kit tarball and spec;
 
+## Patches
+
+If you need to modify your project's sources for whatever reason, feel free to do so and then use `tetra patch "my patch message"` to signal your changes.
+
+After that you can retry the dry-run and spec generation: tetra will take care of creating patch files and adding `%patch` instructions for you.
+
+In case you want to swap sources completely and throw away all previous patches use `tetra patch --new-tarball`.
+
 ## Ant builds
 
-`tetra` is currently optimized for Maven as it is the most common build tool, but it can work with any other. In particular, support for Ant has already been implemented and `tetra ant` works like `tetra mvn`, and a copy of ant is also bundled in `kit/` by default.
+`tetra` works best with Maven but supports Ant as well. `tetra ant` works like `tetra mvn`, and a copy of ant is also bundled in `kit/` by default.
 
-Sometimes you will have jar files distributed along with the source archive that will end up in `src/`: you don't want that! Run
+Sometimes you will have jar files distributed along with the source archive that will end up in `src/`: you don't want that! Run:
 
     tetra move-jars-to-kit
 
-to have them moved to `kit/jars`. The command will generate a symlink back to the original, so builds will work as expected.
+to have them moved to `kit/jars`. The command will generate symlinks back to the originals, so builds will work as expected.
 
-When generating spec files, be sure to have a `pom.xml` in your package directory even if you are not using Maven: `tetra` will automatically take advantage of information from it to compile many fields.
+When generating spec files, it helps to have a `pom.xml` in your package directory even if you are not using Maven, as `tetra` will automatically take advantage of information from it to compile many fields, but it's not required.
 
-You can also ask `tetra` to find one via `tetra get-pom <filename>.jar` (be sure to have Maven in your kit).
+You can also ask `tetra` to find one via `tetra get-pom <filename>.jar`.
 
 ## Other build tools
 
-Other build tools are currently unsupported but will be added in the future. You can nevertheless use them - the only rule is that you have to keep all of their files in `kit`.
+Other build tools are currently unsupported but will be added in the future. You can nevertheless use them just make sure all of their files, included automatically downloaded ones, are stored in `kit`.
 
 ## [OBS](build.opensuse.org) integration
 

data/integration-tests/build-commons.sh

@@ -20,16 +20,11 @@ tetra dry-run finish
 tetra generate-kit
 tetra generate-archive
 tetra generate-spec
-# simulate tetra generate-script
-cd ../..
-cat >packages/commons-collections/build.sh <<"EOF"
-#!/bin/bash
-PROJECT_PREFIX=`readlink -e .`
-cd .
-cd src/commons-collections-3.2.1-src/
-$PROJECT_PREFIX/kit/apache-maven-3.2.5/bin/mvn -Dmaven.repo.local=$PROJECT_PREFIX/kit/m2 -s$PROJECT_PREFIX/kit/m2/settings.xml -o package -DskipTests
-EOF
+
+touch adding_patch_file
+tetra patch "patch file added"
+tetra generate-spec
 
 echo "**************** All Done ****************"
 
-ls -lah *
+find ../../packages

data/lib/template/kit.spec

@@ -33,7 +33,7 @@ It should not be used except for rebuilding other packages,
 thus it should never be installed on end users' systems.
 
 %prep
-%setup -q -c
+%setup -q -n kit
 
 %build
 # nothing to do, precompiled by design

data/lib/template/package.spec

@@ -24,6 +24,9 @@ Url:            <%= url %>
 Group:          Development/Libraries/Java
 Source0:        %{name}.tar.xz
 Source1:        build.sh
+<% patches.to_enum.with_index.each do |patch, i| %>
+Patch<%= i %>:         <%= patch %>
+<% end %>
 BuildRoot:      %{_tmppath}/%{name}-%{version}-build
 BuildRequires:  xz
 BuildRequires:  java-devel
@@ -41,7 +44,10 @@ Requires:       mvn(<%= dependency_id[0] %>:<%= dependency_id[1] %>) <% if depen
 %>
 
 %prep
-%setup -q -c -n src
+%setup -q -n src
+<% (0..(patches.count -1)).each do |i| %>
+%patch<%= i %> -p2
+<% end %>
 cp -f %{SOURCE1} .
 cp -Rf %{_datadir}/tetra ../kit
 

data/lib/tetra.rb

@@ -26,7 +26,6 @@ require "tetra/logger"
 # facades to other programs
 require "tetra/facades/process_runner"
 require "tetra/facades/git"
-require "tetra/facades/tar"
 require "tetra/facades/ant"
 require "tetra/facades/mvn"
 
@@ -40,7 +39,6 @@ require "tetra/maven_website"
 require "tetra/pom_getter"
 
 # package building
-require "tetra/packages/archivable"
 require "tetra/packages/speccable"
 require "tetra/packages/scriptable"
 require "tetra/packages/kit_package"
@@ -59,5 +57,6 @@ require "tetra/ui/get_pom_subcommand"
 require "tetra/ui/init_subcommand"
 require "tetra/ui/move_jars_to_kit_subcommand"
 require "tetra/ui/mvn_subcommand"
+require "tetra/ui/patch_subcommand"
 
 require "tetra/main"

data/lib/tetra/facades/git.rb

@@ -43,29 +43,16 @@ module Tetra
       end
     end
 
-    # returns a list of filenames that changed in the repo
-    # between specified ids, in a certain directory
-    def changed_files_between(start_id, end_id, directory)
-      Dir.chdir(@directory) do
-        run("git diff-tree \
-              --no-commit-id \
-              --name-only \
-              -r #{start_id} #{end_id}\
-              -- #{directory}"
-        ).split("\n")
-      end
-    end
-
     # adds all files in the current directory,
     # removes all files not in the current directory,
     # commits with message
-    def commit_whole_directory(message)
+    def commit_whole_directory(directory, message)
       Dir.chdir(@directory) do
         log.debug "committing with message: #{message}"
 
-        run("git rm -r --cached --ignore-unmatch .")
-        run("git add .")
-        run("git commit --allow-empty -m \"#{message}\"")
+        run("git rm -r --cached --ignore-unmatch #{directory}")
+        run("git add #{directory}")
+        run("git commit --allow-empty -F -", false, message)
       end
     end
 
@@ -74,7 +61,7 @@ module Tetra
       Dir.chdir(@directory) do
         log.debug "committing path #{path} with message: #{message}"
         run("git add #{path}")
-        run("git commit --allow-empty -m \"#{message}\"")
+        run("git commit --allow-empty -F -", false, message)
       end
     end
 
@@ -128,6 +115,40 @@ module Tetra
         conflict_count
       end
     end
+
+    # returns the list of files changed from since_id
+    # including changes in the working tree and staging
+    # area
+    def changed_files(directory, id)
+      Dir.chdir(@directory) do
+        tracked_files = []
+        begin
+          tracked_files += run("git diff-index --name-only #{id} -- #{directory}").split
+        rescue ExecutionFailed => e
+          raise e if e.status != 1 # status 1 is normal
+        end
+
+        untracked_files = run("git ls-files --exclude-standard --others -- #{directory}").split
+        tracked_files + untracked_files
+      end
+    end
+
+    # archives version id of directory in destination_path
+    def archive(directory, id, destination_path)
+      Dir.chdir(@directory) do
+        FileUtils.mkdir_p(File.dirname(destination_path))
+        run("git archive --format=tar #{id} -- #{directory} | xz -9e > #{destination_path}")
+      end
+      destination_path
+    end
+
+    # generates patch files to changes to directory in destination_path
+    # since from_id
+    def format_patch(directory, from_id, destination_path)
+      Dir.chdir(@directory) do
+        run("git format-patch -o #{destination_path} --numbered #{from_id} -- #{directory}").split
+      end
+    end
   end
 
   class GitAlreadyInitedError < StandardError

data/lib/tetra/facades/process_runner.rb

@@ -8,13 +8,14 @@ module Tetra
     # runs an external executable and returns its output as a string
     # 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)
+    def run(commandline, echo = false, stdin = nil)
       log.debug "running `#{commandline}`"
 
       out_recorder = echo ? RecordingIO.new(STDOUT) : RecordingIO.new
       err_recorder = echo ? RecordingIO.new(STDERR) : RecordingIO.new
 
-      status = Open4.spawn(commandline, stdout: out_recorder, stderr: err_recorder, quiet: true).exitstatus
+      status = Open4.spawn(commandline, stdin: stdin, stdout: out_recorder,
+                                        stderr: err_recorder, quiet: true).exitstatus
 
       log.debug "`#{commandline}` exited with status #{status}"
 
@@ -27,7 +28,7 @@ module Tetra
           log.warn(out) unless out == ""
           log.warn(err) unless err == ""
         end
-        fail ExecutionFailed.new(commandline, status)
+        fail ExecutionFailed.new(commandline, status, out, err)
       end
 
       out_recorder.record
@@ -57,10 +58,18 @@ module Tetra
   class ExecutionFailed < Exception
     attr_reader :commandline
     attr_reader :status
+    attr_reader :out
+    attr_reader :err
 
-    def initialize(commandline, status)
+    def initialize(commandline, status, out, err)
       @commandline = commandline
       @status = status
+      @out = out
+      @err = err
+    end
+
+    def to_s
+      "\"#{@commandline}\" failed with status #{@status}\n#{out}\n#{err}"
     end
   end
 end

data/lib/tetra/main.rb

@@ -57,6 +57,12 @@ module Tetra
       Tetra::GenerateAllSubcommand
     )
 
+    subcommand(
+      "patch",
+      "Saves changes in source files for inclusion in a patch",
+      Tetra::PatchSubcommand
+    )
+
     subcommand(
       "move-jars-to-kit",
       "Locates jars in src/ and moves them to kit/",

data/lib/tetra/packages/kit_package.rb

@@ -4,7 +4,6 @@ module Tetra
   # a packaged set of binary build-time dependencies
   class KitPackage
     extend Forwardable
-    include Archivable
     include Speccable
 
     attr_reader :name
@@ -17,11 +16,6 @@ module Tetra
       @name = "#{project.name}-kit"
     end
 
-    def to_archive
-      _to_archive(@project, name, "kit",
-                  @project.packages_dir)
-    end
-
     def to_spec
       _to_spec(@project, name, "kit.spec",
                @project.packages_dir)

data/lib/tetra/packages/package.rb

@@ -4,10 +4,11 @@ module Tetra
   # represents a Java project packaged in tetra
   class Package
     extend Forwardable
-    include Archivable
     include Speccable
     include Scriptable
 
+    attr_reader :patches
+
     def_delegator :@project, :name, :name
     def_delegator :@kit, :name, :kit_name
     def_delegator :@kit, :version, :kit_version
@@ -18,11 +19,12 @@ module Tetra
     def_delegator :@pom, :version
     def_delegator :@pom, :runtime_dependency_ids
 
-    def initialize(project, pom_path = nil, filter = nil)
+    def initialize(project, pom_path = nil, filter = nil, patches = [])
       @project = project
       @kit = Tetra::KitPackage.new(project)
       @pom = Tetra::Pom.new(pom_path)
       @filter = filter
+      @patches = patches.map { |f| File.basename(f) }
     end
 
     # a short summary from the POM
@@ -51,10 +53,6 @@ module Tetra
         .sub(/\.+$/, "")
     end
 
-    def to_archive
-      _to_archive(@project, name, "src", @project.packages_dir)
-    end
-
     def to_spec
       _to_spec(@project, name, "package.spec", @project.packages_dir)
     end

data/lib/tetra/pom.rb

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

data/lib/tetra/project.rb

@@ -61,7 +61,7 @@ module Tetra
           FileUtils.cp_r(File.join(TEMPLATE_PATH, source), destination)
         end
 
-        project.commit_whole_project("Template files added")
+        project.commit_whole_directory(".", "Template files added")
       end
     end
 
@@ -86,16 +86,26 @@ module Tetra
       result
     end
 
+    # checks whether there were edits to src/
+    # since last mark
+    def src_patched?
+      from_directory do
+        latest_id = @git.latest_id("tetra: sources-")
+        if latest_id
+          @git.changed_files("src", latest_id).any?
+        else
+          false
+        end
+      end
+    end
+
     # starts a dry running phase: files added to kit/ will be added
     # to the kit package, src/ will be reset at the current state
     # when finished
     def dry_run
-      return false if dry_running?
-
       current_directory = Pathname.new(Dir.pwd).relative_path_from(Pathname.new(@full_path))
 
-      commit_whole_project("Dry-run started", "tetra: dry-run-started: #{current_directory}")
-      true
+      commit_whole_directory(".", "Dry-run started\n", "tetra: dry-run-started: #{current_directory}")
     end
 
     # returns true iff we are currently dry-running
@@ -107,30 +117,35 @@ module Tetra
     # ends a dry-run assuming a successful build
     # reverts sources and updates output file lists
     def finish
-      if dry_running?
-        commit_whole_project("Changes during dry-run", "tetra: dry-run-changed")
+      # keep track of changed files
+      start_id = @git.latest_id("tetra: dry-run-started")
+      changed_files = @git.changed_files("src", start_id)
 
-        @git.revert_whole_directory("src", @git.latest_id("tetra: dry-run-started"))
+      # revert to pre-dry-run status
+      @git.revert_whole_directory("src", start_id)
 
-        commit_whole_project("Dry run finished", "tetra: dry-run-finished")
-        return true
+      # prepare commit comments
+      comments = ["Dry run finished\n", "tetra: dry-run-finished"]
+      comments += changed_files.map { |f| "tetra: file-changed: #{f}" }
+
+      # if this is the first dry-run, mark sources as tarball
+      if @git.latest_id("tetra: dry-run-finished").nil?
+        comments << "tetra: sources-tarball"
       end
-      false
+
+      # commit end of dry run
+      commit_whole_directory(".", *comments)
     end
 
-    # ends a dry-run assuming the built went wrong
+    # ends a dry-run assuming the build went wrong
     # reverts the whole project directory
     def abort
-      if dry_running?
-        @git.revert_whole_directory(".", @git.latest_id("tetra: dry-run-started"))
-        @git.undo_last_commit
-        return true
-      end
-      false
+      @git.revert_whole_directory(".", @git.latest_id("tetra: dry-run-started"))
+      @git.undo_last_commit
     end
 
-    # commits all files in the project
-    def commit_whole_project(*comments)
+    # commits all files in the directory
+    def commit_whole_directory(directory, *comments)
       # rename all .gitignore files that might have slipped in
       from_directory("src") do
         Find.find(".") do |file|
@@ -140,7 +155,16 @@ module Tetra
         end
       end
 
-      @git.commit_whole_directory(comments.join("\n\n"))
+      @git.commit_whole_directory(directory, comments.join("\n"))
+    end
+
+    # commits files in the src/ dir as a patch or tarball update
+    def commit_sources(message, new_tarball = false)
+      from_directory do
+        comments = ["#{message}\n"]
+        comments << "tetra: sources-tarball" if new_tarball
+        commit_whole_directory("src", comments)
+      end
     end
 
     # replaces content in path with new_content, commits using
@@ -172,8 +196,11 @@ module Tetra
 
         if already_existing
           # 3-way merge
-          conflict_count = @git.merge_with_id("#{path}", "#{path}.tetra_user_edited", previous_id)
+          conflict_count = @git.merge_with_id(path, "#{path}.tetra_user_edited", previous_id)
           File.delete("#{path}.tetra_user_edited")
+
+          @git.commit_file(path, "User changes merged back") if conflict_count == 0
+
           return conflict_count
         end
         return 0
@@ -194,14 +221,42 @@ module Tetra
 
     # returns a list of files produced during the last dry-run
     def produced_files
-      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
-        []
+      @git.latest_comment("tetra: dry-run-finished")
+        .split("\n")
+        .map { |line| line[/^tetra: file-changed: src\/(.+)$/, 1] }
+        .compact
+        .sort
+    end
+
+    # archives a tarball of src/ in packages/
+    # the latest commit marked as tarball is taken as the version
+    def archive_sources
+      from_directory do
+        id = @git.latest_id("tetra: sources-tarball")
+        destination_path = File.join(full_path, packages_dir, name, "#{name}.tar.xz")
+        @git.archive("src", id, destination_path)
+      end
+    end
+
+    # archives a tarball of kit/ in packages/
+    # the latest commit marked as dry-run-finished is taken as the version
+    def archive_kit
+      from_directory do
+        id = @git.latest_id("tetra: dry-run-finished")
+        destination_path = File.join(full_path, packages_dir, "#{name}-kit", "#{name}-kit.tar.xz")
+        @git.archive("kit", id, destination_path)
+      end
+    end
+
+    # generates patches of src/ in packages/
+    # the latest commit marked as tarball is taken as the base version,
+    # other commits are assumed to be patches on top
+    # returns filenames
+    def write_source_patches
+      from_directory do
+        id = @git.latest_id("tetra: sources-tarball")
+        destination_path = File.join(full_path, packages_dir, name)
+        @git.format_patch("src", id, destination_path)
       end
     end