tetra 0.51.0 → 0.52.0

data/README.md

@@ -12,6 +12,7 @@ You need:
 
 * [Ruby 1.9](https://www.ruby-lang.org/en/);
 * [git](http://git-scm.com/);
+* bash;
 * a JDK that can compile whatever software you need to package;
 
 Install `tetra` via RubyGems:
@@ -23,15 +24,20 @@ Install `tetra` via RubyGems:
 Building a package with `tetra` is quite unusual — this is a deliberate choice, so don't worry. Basic steps are:
 
 * `tetra init` a new project;
-* add sources to `src/<package name>` and anything else needed for the build in `kit/` in binary form (typically a copy of Maven and maybe some other dependency jars);
-* execute `tetra dry-run start`, then any command needed to compile your software, then `tetra dry-run finish`;
-* execute `tetra generate-all`: tetra will look at changed files and Bash history to scaffold spec files and tarballs.
+* add sources to `src/<package name>` and anything else needed for the build in `kit/` in binary form (Ant and Maven are already included);
+* execute `tetra dry-run`, which will open a bash subshell. In there, build your project, and when you are done conclude quitting it with `Ctrl+D`;
+* execute `tetra generate-all`: tetra will scaffold spec files and tarballs.
 
 Done!
 
 ### How can that possibly work?
 
-With `tetra` you are not building all dependencies from source, just your package. Everything else is shipped already compiled with attached source files, which is much easier to implement and automate. Yet, it is sufficient to fulfill open source licenses and to have a repeatable, networkless build.
+During the dry-run `tetra`:
+ - saves your bash history, so that it can use it later to scaffold a build script;
+ - keeps track of changed files, in particular produced jars, which are included in the spec's `%files` section;
+ - saves files downloaded from the Internet (eg. by Maven) and packs them to later allow networkless builds.
+
+Note that with `tetra` you are not building all dependencies from source - build dependencies are aggregated in a binary-only "blob" package. While this is not ideal it is sufficient to fulfill most open source licenses and to have a repeatable, networkless build, while being a lot easier to automate.
 
 ## A commons-collections walkthrough
 
@@ -48,18 +54,18 @@ Second, place source files in the `src/` folder:
     unzip commons-collections-3.2.1-src.zip
     rm commons-collections-3.2.1-src.zip
 
-Third, you need to show `tetra` how to build your package by running appropriate commands between `tetra dry-run start` and `tetra dry-run finish`. Bash history will be recorded to generate a "starting-point" build script (that will be sufficient in simple cases like this):
+Third, you need to show `tetra` how to build your package. Run `tetra dry-run` a new subshell will open, in there do anything you would normally do to build the package:
 
     cd ../src
-    tetra dry-run start
+    tetra dry-run
 
     cd commons-collections-3.2.1-src/
     tetra mvn package
 
-    tetra dry-run finish
+    ^D
 
 Note that we used `tetra mvn package` instead of `mvn package`: this will use a preloaded Maven bundled in `kit/` by default and the repository in `kit/m2`.
-Also note that this being a dry-run build, sources will be brought back to their original state after `tetra finish`, as this ensures build repeatability.
+Also note that this being a dry-run build, sources will be brought back to their original state after it finishes to ensure repeatability.
 
 Finally, generate build scripts, spec files and tarballs in the `packages/` directory:
 
@@ -75,9 +81,9 @@ An in-depth discussion of this project's motivation is available in the [MOTIVAT
 
 ## Status
 
-`tetra` is a research project currently in beta state. If you are a packager you can try to use it, any feedback would be **very** welcome!
+`tetra` will soon hit 1.0. If you are a packager you can try to use it, any feedback would be **very** welcome!
 
-At the moment `tetra` is tested on openSUSE.
+At the moment `tetra` is tested on openSUSE and Ubuntu.
 
 ## Sources
 

data/SPECIAL_CASES.md

@@ -1,8 +1,8 @@
 # Special cases
 
-## Failing builds
+## Failing dry-runs
 
-If your build fails for whatever reason, abort it with `tetra finish abort`. `tetra` will restore all project files as they were before build.
+If your build fails for whatever reason during a dry run, abort it with `^C^D` (`Ctrl+C` followed by `Ctrl+D`). `tetra` will restore all project files as they were before the build.
 
 ## Generating files multiple times
 
@@ -12,7 +12,7 @@ You can edit any file generated by tetra - regenerating it later will not overwr
 
 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-script`: (re)generates the `build.sh` file from commands used in the latest successful dry-run;
 * `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;

data/lib/tetra.rb

@@ -28,6 +28,7 @@ require "tetra/facades/process_runner"
 require "tetra/facades/git"
 require "tetra/facades/ant"
 require "tetra/facades/mvn"
+require "tetra/facades/bash"
 
 # main internal classes
 require "tetra/version"

data/lib/tetra/facades/bash.rb

@@ -0,0 +1,28 @@
+# encoding: UTF-8
+
+module Tetra
+  # runs Bash with tetra-specific options
+  class Bash
+    include ProcessRunner
+
+    # runs bash in a subshell, returns list of
+    # commands that were run in the session
+    def bash
+      Tempfile.open("tetra-history") do |temp_file|
+        temp_path = temp_file.path
+
+        env = {
+          "HISTFILE" => temp_path,   # use temporary file for history
+          "HISTFILESIZE" => "-1", # don't limit file size
+          "HISTSIZE" => "-1", # don't limit history size
+          "HISTTIMEFORMAT" => nil, # don't keep timestamps
+          "HISTCONTROL" => "", # don't skip any command
+          "PS1" => "\e[1;33mdry-running\e[m:\\\w\$ " # change prompt
+        }
+
+        run_interactive("bash --norc", env)
+        File.read(temp_path).split("\n").map(&:strip)
+      end
+    end
+  end
+end

data/lib/tetra/facades/process_runner.rb

@@ -5,7 +5,7 @@ module Tetra
   module ProcessRunner
     include Logging
 
-    # runs an external executable and returns its output as a string
+    # runs a noninteractive 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, stdin = nil)
@@ -34,6 +34,13 @@ module Tetra
       out_recorder.record
     end
 
+    # runs an interactive executable in a subshell
+    # changing environment variables
+    def run_interactive(command, env)
+      success = system(env, command)
+      fail ExecutionFailed.new(command, $CHILD_STATUS, nil, nil) unless success
+    end
+
     # records bytes sent via "<<" for later use
     # optionally echoes to another IO object
     class RecordingIO

data/lib/tetra/packages/package.rb

@@ -57,8 +57,8 @@ module Tetra
       _to_spec(@project, name, "package.spec", @project.packages_dir)
     end
 
-    def to_script(history)
-      _to_script(@project, history)
+    def to_script
+      _to_script(@project)
     end
   end
 end

data/lib/tetra/packages/scriptable.rb

@@ -4,23 +4,14 @@ module Tetra
   # generates a package build script from bash_history
   module Scriptable
     # returns a build script for this package
-    def _to_script(project, history_path)
+    def _to_script(project)
       project.from_directory do
-        history_lines = File.readlines(history_path).map(&:strip)
-        relevant_lines =
-          history_lines
-          .reverse
-          .take_while { |e| e.match(/tetra +dry-run +start/).nil? }
-          .reverse
-          .take_while { |e| e.match(/tetra +dry-run +finish/).nil? }
-          .select { |e| e.match(/^#/).nil? }
-
         script_lines = [
           "#!/bin/bash",
           "set -xe",
           "PROJECT_PREFIX=`readlink -e .`",
           "cd #{project.latest_dry_run_directory}"
-        ] + script_body(project, relevant_lines)
+        ] + script_body(project)
 
         new_content = script_lines.join("\n") + "\n"
 
@@ -34,19 +25,21 @@ module Tetra
       end
     end
 
-    # returns the script body
-    def script_body(project, relevant_lines)
-      ant = if relevant_lines.any? { |e| e.match(/tetra +ant/) }
+    # returns the script body by taking the last dry-run's
+    # build script lines and adjusting mvn and ant's paths
+    def script_body(project)
+      lines = project.build_script_lines
+      ant = if lines.any? { |e| e.match(/tetra +ant/) }
               path = Tetra::Kit.new(project).find_executable("ant")
               Tetra::Ant.new(project.full_path, path).ant(@options)
             end
 
-      mvn = if relevant_lines.any? { |e| e.match(/tetra +mvn/) }
+      mvn = if lines.any? { |e| e.match(/tetra +mvn/) }
               mvn_path = Tetra::Kit.new(project).find_executable("mvn")
               mvn = Tetra::Mvn.new("$PROJECT_PREFIX", mvn_path)
             end
 
-      relevant_lines.map do |line|
+      lines.map do |line|
         if line =~ /tetra +mvn/
           line.gsub(/tetra +mvn/, "#{mvn.get_mvn_commandline(['-o'])}")
         elsif line =~ /tetra +ant/

data/lib/tetra/project.rb

@@ -114,9 +114,11 @@ module Tetra
       !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
+    # ends a dry-run assuming a successful build:
+    #  - reverts sources as before dry-run
+    #  - saves the list of generated files in git comments
+    #  - saves the build script lines in git comments
+    def finish(build_script_lines)
       # keep track of changed files
       start_id = @git.latest_id("tetra: dry-run-started")
       changed_files = @git.changed_files("src", start_id)
@@ -127,6 +129,7 @@ module Tetra
       # prepare commit comments
       comments = ["Dry run finished\n", "tetra: dry-run-finished"]
       comments += changed_files.map { |f| "tetra: file-changed: #{f}" }
+      comments += build_script_lines.map { |l| "tetra: build-script-line: #{l}" }
 
       # if this is the first dry-run, mark sources as tarball
       if @git.latest_id("tetra: dry-run-finished").nil?
@@ -228,6 +231,14 @@ module Tetra
         .sort
     end
 
+    def build_script_lines
+      @git.latest_comment("tetra: dry-run-finished")
+        .split("\n")
+        .map { |line| line[/^tetra: build-script-line: (.+)$/, 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

data/lib/tetra/ui/dry_run_subcommand.rb

@@ -3,55 +3,30 @@
 module Tetra
   # tetra dry-run
   class DryRunSubcommand < Tetra::Subcommand
-    parameter "COMMAND", "\"start\" to begin, \"finish\" to end or \"abort\" to undo changes" do |command|
-      if %w(start finish abort).include?(command)
-        command
-      else
-        fail ArgumentError, "\"#{command}\" is not valid, must be one of \"start\", \"finish\" or \"abort\""
-      end
-    end
-
     def execute
       checking_exceptions do
         project = Tetra::Project.new(".")
-        send(command, project)
-      end
-    end
 
-    def start(project)
-      if !project.dry_running?
         if project.src_patched?
-          puts "Some files in src/ were changed since last dry-run."
-          puts "Use \"tetra patch message\" to include changes in a patch before dry-running."
-          puts "Dry run not started."
+          puts "Some files in src/ were changed since last dry-run,"
+          puts "use \"tetra patch message\" to include changes in a patch before dry-running."
+          puts "Dry run not started"
         else
           project.dry_run
-          puts "Now dry-running, please start your build."
-          puts "To run a Maven installation from the kit, use \"tetra mvn\"."
-          puts "If the build succeedes end this dry run with \"tetra dry-run finish\"."
-          puts "If the build does not succeed use \"tetra dry-run abort\" to undo any change."
-        end
-      else
-        puts "Dry-run already in progress."
-        puts "Use \"tetra dry-run finish\" to end it or \"tetra dry-run abort\" to undo changes."
-      end
-    end
-
-    def finish(project)
-      if project.dry_running?
-        project.finish
-        puts "Dry-run finished."
-      else
-        puts "No dry-run is in progress."
-      end
-    end
+          puts "Dry-run started in a new bash shell."
+          puts "Build your project now, you can use \"tetra mvn\" and \"tetra ant\"."
+          puts "If the build succeedes end this dry run with ^D (Ctrl+D),"
+          puts "if the build does not succeed use ^C^D to abort and undo any change"
 
-    def abort(project)
-      if project.dry_running?
-        project.abort
-        puts "Project reverted as before dry-run."
-      else
-        puts "No dry-run is in progress."
+          begin
+            history = Bash.new.bash
+            project.finish(history)
+            puts "Dry-run finished"
+          rescue ExecutionFailed
+            project.abort
+            puts "Project reverted as before dry-run"
+          end
+        end
       end
     end
   end

data/lib/tetra/ui/generate_script_subcommand.rb

@@ -7,9 +7,8 @@ module Tetra
       checking_exceptions do
         project = Tetra::Project.new(".")
         ensure_dry_running(:has_finished, project) do
-          history = File.join(Dir.home, ".bash_history")
           result_path, conflict_count =
-            Tetra::Package.new(project).to_script(history)
+            Tetra::Package.new(project).to_script
           print_generation_result(project, result_path, conflict_count)
         end
       end

data/lib/tetra/ui/init_subcommand.rb

@@ -8,7 +8,7 @@ module Tetra
         Tetra::Project.init(".")
         puts "Project inited."
         puts "Add sources to src/, binary dependencies to kit/."
-        puts "When you are ready to test a build, use \"tetra dry-run\"."
+        puts "When you are ready to test a build, use \"tetra dry-run\""
       end
     end
   end

data/lib/tetra/ui/subcommand.rb

@@ -59,10 +59,10 @@ module Tetra
       else
         if (state == :is_in_progress) ||
            (state == :has_finished && !dry_running && !has_finished)
-          puts "Please start a dry-run first, use \"tetra dry-run start\""
+          puts "Please start a dry-run first, use \"tetra dry-run\""
         elsif (state == :is_not_in_progress) ||
               (state == :has_finished && dry_running)
-          puts "Please finish or abort this dry-run first, use \"tetra dry-run finish\" or \"tetra dry-run abort\""
+          puts "There is a dry-run in progress, please finish it (^D) or abort it (^C^D)"
         end
       end
     end

data/lib/tetra/version.rb

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

data/spec/lib/package_spec.rb

@@ -11,7 +11,7 @@ describe Tetra::Package do
     Dir.chdir(@project_path) do
       FileUtils.touch(File.join("kit", "jars", "test.jar"))
     end
-    @project.finish
+    @project.finish([])
 
     @project.from_directory do
       FileUtils.mkdir_p(File.join("src", "out"))
@@ -28,7 +28,7 @@ describe Tetra::Package do
         FileUtils.touch(File.join("src", "out", "test#{i}.jar"))
       end
 
-      @project.finish
+      @project.finish([])
     end
 
     FileUtils.copy(File.join("spec", "data", "nailgun", "pom.xml"), @project_path)

data/spec/lib/project_spec.rb

@@ -20,7 +20,7 @@ describe Tetra::Project do
 
     it "returns a project version after dry-run" do
       @project.dry_run
-      @project.finish
+      @project.finish([])
       expect(@project.version).to be
     end
   end
@@ -77,7 +77,7 @@ describe Tetra::Project do
         expect(@project.dry_running?).to be_falsey
         @project.dry_run
         expect(@project.dry_running?).to be_truthy
-        @project.finish
+        @project.finish([])
         expect(@project.dry_running?).to be_falsey
       end
     end
@@ -87,7 +87,7 @@ describe Tetra::Project do
     it "checks whether src is dirty" do
       @project.from_directory do
         @project.dry_run
-        @project.finish
+        @project.finish([])
         expect(@project.src_patched?).to be_falsey
 
         FileUtils.touch(File.join("src", "test"))
@@ -129,7 +129,7 @@ describe Tetra::Project do
         FileUtils.touch(File.join("src", "test2"))
       end
 
-      expect(@project.finish).to be_truthy
+      expect(@project.finish([])).to be_truthy
       expect(@project.dry_running?).to be_falsey
 
       @project.from_directory do
@@ -200,13 +200,13 @@ describe Tetra::Project do
         File.open(File.join("src", "added_in_first_dry_run"), "w") { |f| f.write("A") }
         File.open("added_outside_directory", "w") { |f| f.write("A") }
       end
-      expect(@project.finish).to be_truthy
+      expect(@project.finish([])).to be_truthy
 
       expect(@project.dry_run).to be_truthy
       @project.from_directory do
         File.open(File.join("src", "added_in_second_dry_run"), "w") { |f| f.write("A") }
       end
-      expect(@project.finish).to be_truthy
+      expect(@project.finish([])).to be_truthy
 
       list = @project.produced_files
       expect(list).to include("added_in_second_dry_run")

data/spec/lib/scriptable_spec.rb

@@ -9,17 +9,16 @@ describe Tetra::Scriptable do
     create_mock_project
 
     @project.from_directory do
-      File.open("history", "w") do |io|
-        io.puts "some earlier command"
-        io.puts "tetra dry-run start --unwanted-options"
-        io.puts "cd somewhere significant"
-        io.puts "tetra mvn --options"
-        io.puts "tetra dry-run finish -a"
-        io.puts "some later command"
-      end
-
       FileUtils.mkdir_p(File.join("src", "test-package"))
       @project.dry_run
+
+      history = ["tetra dry-run start --unwanted-options",
+                 "cd somewhere significant",
+                 "tetra mvn --options",
+                 "tetra dry-run finish -a"
+                ]
+
+      @project.finish(history)
     end
 
     create_mock_executable("ant")
@@ -34,7 +33,7 @@ describe Tetra::Scriptable do
     it "generates a build script from the history" do
       @project.from_directory do
         @package = Tetra::Package.new(@project)
-        @package.to_script("history")
+        @package.to_script
 
         lines = File.readlines(File.join("packages", "test-project", "build.sh"))
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tetra
 version: !ruby/object:Gem::Version
-  version: 0.51.0
+  version: 0.52.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-27 00:00:00.000000000 Z
+date: 2015-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -352,6 +352,7 @@ files:
 - lib/template/src/CONTENTS
 - lib/tetra.rb
 - lib/tetra/facades/ant.rb
+- lib/tetra/facades/bash.rb
 - lib/tetra/facades/git.rb
 - lib/tetra/facades/mvn.rb
 - lib/tetra/facades/process_runner.rb