tetra 0.46.0 → 0.48.0

data/lib/tetra.rb

@@ -18,45 +18,46 @@ require "json"
 require "nokogiri"
 require "rest_client"
 require "zip"
+require "open4"
 
-# internal, backend
-require "tetra/version"
+# base components
 require "tetra/logger"
-require "tetra/git"
+
+# 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"
+
+# main internal classes
+require "tetra/version"
 require "tetra/project"
 require "tetra/pom"
+require "tetra/kit"
 require "tetra/version_matcher"
 require "tetra/maven_website"
 require "tetra/pom_getter"
-require "tetra/source_getter"
-require "tetra/kit_runner"
-require "tetra/ant_runner"
-require "tetra/maven_runner"
-require "tetra/kit_checker"
 
-# internal, package related
+# package building
 require "tetra/packages/archivable"
 require "tetra/packages/speccable"
 require "tetra/packages/scriptable"
-require "tetra/packages/kit"
-require "tetra/packages/built_package"
-
-# internal, UI
-require "tetra/commands/base"
-require "tetra/commands/ant"
-require "tetra/commands/download_maven_source_jars"
-require "tetra/commands/dry_run"
-require "tetra/commands/finish"
-require "tetra/commands/generate_all"
-require "tetra/commands/generate_kit"
-require "tetra/commands/generate_archive"
-require "tetra/commands/generate_script"
-require "tetra/commands/generate_spec"
-require "tetra/commands/get_pom"
-require "tetra/commands/get_source"
-require "tetra/commands/init"
-require "tetra/commands/list_kit_missing_sources"
-require "tetra/commands/move_jars_to_kit"
-require "tetra/commands/mvn"
+require "tetra/packages/kit_package"
+require "tetra/packages/package"
+
+# UI
+require "tetra/ui/subcommand"
+require "tetra/ui/ant_subcommand"
+require "tetra/ui/dry_run_subcommand"
+require "tetra/ui/generate_all_subcommand"
+require "tetra/ui/generate_kit_subcommand"
+require "tetra/ui/generate_archive_subcommand"
+require "tetra/ui/generate_script_subcommand"
+require "tetra/ui/generate_spec_subcommand"
+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/main"

data/lib/tetra/facades/ant.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+module Tetra
+  # runs Ant with tetra-specific options
+  class Ant
+    include Logging
+    include ProcessRunner
+
+    # project_path is relative to the current dir
+    # ant_path is relative to project_path
+    def initialize(project_path, ant_path)
+      @project_path = project_path
+      @ant_path = ant_path
+    end
+
+    # runs ant in a subprocess
+    def ant(options)
+      run(get_ant_commandline(options), true)
+    end
+
+    # returns a command line for running Ant
+    def get_ant_commandline(options)
+      full_path = File.join(@project_path, @ant_path)
+      "#{full_path} #{options.join(' ')}"
+    end
+  end
+end

data/lib/tetra/{git.rb → facades/git.rb}

@@ -5,6 +5,7 @@ module Tetra
   # prefixes all tags with "tetra_"
   class Git
     include Logging
+    include ProcessRunner
 
     # inits a new git manager object pointing to the specified
     # directory
@@ -16,7 +17,7 @@ module Tetra
     def init
       Dir.chdir(@directory) do
         if Dir.exist?(".git") == false
-          `git init`
+          run("git init")
         else
           fail GitAlreadyInitedError
         end
@@ -41,8 +42,12 @@ module Tetra
             "HEAD"
           end
         )
-        `git diff-tree --no-commit-id --name-only -r #{prefixed_start_tag} #{prefixed_end_tag} -- #{directory}`
-          .split("\n")
+        run("git diff-tree \
+              --no-commit-id \
+              --name-only \
+              -r #{prefixed_start_tag} #{prefixed_end_tag}\
+              -- #{directory}"
+        ).split("\n")
       end
     end
 
@@ -53,14 +58,14 @@ module Tetra
       Dir.chdir(@directory) do
         log.debug "committing with message: #{message}"
 
-        `git rm -r --cached --ignore-unmatch .`
-        `git add .`
-        `git commit -m "#{message}"`
+        run("git rm -r --cached --ignore-unmatch .")
+        run("git add .")
+        run("git commit -m \"#{message}\"", false, false)
 
         if !tag_message.nil?
-          `git tag tetra_#{tag} -m "#{tag_message}"`
+          run("git tag tetra_#{tag} -m \"#{tag_message}\"")
         else
-          `git tag tetra_#{tag}`
+          run("git tag tetra_#{tag}")
         end
       end
     end
@@ -70,16 +75,16 @@ module Tetra
     def commit_file(path, message, tag)
       Dir.chdir(@directory) do
         log.debug "committing path #{path} with message: #{message}"
-        `git add #{path}`
-        `git commit -m "#{message}"`
-        `git tag tetra_#{tag}`
+        run("git add #{path}")
+        run("git commit -m \"#{message}\"", false, false)
+        run("git tag tetra_#{tag}")
       end
     end
 
     # returns the highest suffix found in tags with the given prefix
     def get_tag_maximum_suffix(prefix)
       Dir.chdir(@directory) do
-        `git tag`.split.map do |tag|
+        run("git tag").split.map do |tag|
           if tag =~ /^tetra_#{prefix}_([0-9]+)$/
             Regexp.last_match[1].to_i
           else
@@ -93,12 +98,12 @@ module Tetra
     def revert_whole_directory(path, tag)
       Dir.chdir(@directory) do
         # reverts added and modified files, both in index and working tree
-        `git checkout -f tetra_#{tag} -- #{path}`
+        run("git checkout -f tetra_#{tag} -- #{path}")
 
         # compute the list of deleted files
-        files_in_tag = `git ls-tree --name-only -r tetra_#{tag} -- #{path}`.split("\n")
-        files_in_head = `git ls-tree --name-only -r HEAD -- #{path}`.split("\n")
-        files_added_after_head = `git ls-files -o -- #{path}`.split("\n")
+        files_in_tag = run("git ls-tree --name-only -r tetra_#{tag} -- #{path}").split("\n")
+        files_in_head = run("git ls-tree --name-only -r HEAD -- #{path}").split("\n")
+        files_added_after_head = run("git ls-files -o -- #{path}").split("\n")
         files_to_delete = files_in_head - files_in_tag + files_added_after_head
 
         files_to_delete.each do |file|
@@ -112,13 +117,13 @@ module Tetra
     # returns the conflict count
     def merge_with_tag(path, new_path, tag)
       Dir.chdir(@directory) do
-        log.debug "calling git show tetra_#{tag}:#{path} > #{path}.old_version, output follows"
-        `git show tetra_#{tag}:#{path} > #{path}.old_version`
-        log.debug "calling git merge-file #{path} #{path}.old_version #{new_path}, output follows"
-        `git merge-file #{path} #{path}.old_version #{new_path} \
-          -L "newly generated" -L "previously generated" -L "user edited"`
+        run("git show tetra_#{tag}:#{path} > #{path}.old_version")
+        run("git merge-file #{path} #{path}.old_version #{new_path} \
+              -L \"newly generated\" \
+              -L \"previously generated\" \
+              -L \"user edited\"")
         conflict_count = $CHILD_STATUS.exitstatus
-        File.delete "#{path}.old_version"
+        File.delete("#{path}.old_version")
         return conflict_count
       end
     end
@@ -126,13 +131,13 @@ module Tetra
     # deletes a tag
     def delete_tag(tag)
       Dir.chdir(@directory) do
-        `git tag -d tetra_#{tag}`
+        run("git tag -d tetra_#{tag}")
       end
     end
 
     # returns the tag message
     def get_message(tag)
-      `git cat-file tag tetra_#{tag}`.split.last
+      run("git cat-file tag tetra_#{tag}").split.last
     end
   end
 

data/lib/tetra/facades/mvn.rb

@@ -0,0 +1,44 @@
+# encoding: UTF-8
+
+module Tetra
+  # runs Maven with tetra-specific options
+  class Mvn
+    include Logging
+    include ProcessRunner
+
+    # project_path is relative to the current dir
+    # mvn_path is relative to project_path
+    def initialize(project_path, mvn_path)
+      @project_path = project_path
+      @mvn_path = mvn_path
+    end
+
+    # runs Maven in a subprocess
+    def mvn(options)
+      run(get_mvn_commandline(options), true)
+    end
+
+    # runs Maven to get the effective POM from an existing POM
+    # returns effective pom path or nil if not found
+    def get_effective_pom(pom_path)
+      effective_pom_path = "#{pom_path}.effective"
+      success = mvn(["help:effective-pom", "-f#{pom_path}", "-Doutput=#{File.split(effective_pom_path)[1]}"])
+      effective_pom_path if success
+    end
+
+    # returns a command line for running Maven
+    def get_mvn_commandline(options)
+      full_path = File.join(@project_path, @mvn_path)
+      repo_path = File.join(@project_path, "kit", "m2")
+      config_path = File.join(@project_path, "kit", "m2", "settings.xml")
+
+      full_options = [
+        "-Dmaven.repo.local=#{repo_path}",
+        "--settings #{config_path}",
+        "--strict-checksums"
+      ] + options
+
+      "#{full_path} #{full_options.join(' ')}"
+    end
+  end
+end

data/lib/tetra/facades/process_runner.rb

@@ -0,0 +1,65 @@
+# encoding: UTF-8
+
+module Tetra
+  # runs programs in subprocesses
+  module ProcessRunner
+    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)
+    # optionally echoes the executable's output/error to standard output/error
+    def run(commandline, echo = false, fail_on_error = true)
+      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
+
+      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)
+        end
+      end
+
+      out_recorder.record
+    end
+
+    # records bytes sent via "<<" for later use
+    # optionally echoes to another IO object
+    class RecordingIO
+      attr_reader :record
+
+      def initialize(io = nil)
+        @io = io
+        @record = ""
+      end
+
+      def <<(*args)
+        if @io
+          @io.<<(*args)
+          @io.flush
+        end
+        @record.<<(*args)
+      end
+    end
+  end
+
+  # raised when a command returns a non-zero status
+  class ExecutionFailed < Exception
+    attr_reader :commandline
+    attr_reader :status
+
+    def initialize(commandline, status)
+      @commandline = commandline
+      @status = status
+    end
+  end
+end

data/lib/tetra/facades/tar.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+
+module Tetra
+  # facade to tar
+  class Tar
+    include Logging
+    include ProcessRunner
+
+    def archive(name, source_dir, destination_dir)
+      log.debug("creating #{destination_dir}")
+      FileUtils.mkdir_p(destination_dir)
+
+      destination_path = File.join(destination_dir, "#{name}.tar.xz")
+
+      run("tar -cJf #{destination_path} -C #{source_dir} .")
+
+      destination_path
+    end
+  end
+end

data/lib/tetra/{kit_runner.rb → kit.rb}

@@ -1,8 +1,8 @@
 # encoding: UTF-8
 
 module Tetra
-  # runs programs from a tetra kit with tetra-specific options
-  class KitRunner
+  # encapsulates a Tetra kit directory
+  class Kit
     include Logging
 
     def initialize(project)
@@ -21,14 +21,7 @@ module Tetra
       end
 
       log.debug("#{name} executable not found")
-      nil
-    end
-
-    # runs an external executable, returns true on success
-    def run_executable(full_commandline)
-      log.debug "running #{full_commandline}"
-      Process.wait(Process.spawn(full_commandline))
-      $CHILD_STATUS.exitstatus == 0
+      fail ExecutableNotFoundError, name
     end
   end
 

data/lib/tetra/main.rb

@@ -6,91 +6,67 @@ module Tetra
     subcommand(
       "init",
       "Inits a tetra project in the current directory",
-      Tetra::InitCommand
+      Tetra::InitSubcommand
     )
 
     subcommand(
       "dry-run",
-      "Starts a dry-run build",
-      Tetra::DryRunCommand
+      "Starts or ends a dry-run build",
+      Tetra::DryRunSubcommand
     )
 
     subcommand(
       "mvn",
       "Locates and runs Maven from any directory in kit/",
-      Tetra::MavenCommand
+      Tetra::MvnSubcommand
     )
 
     subcommand(
       "ant",
       "Locates and runs Ant from any directory in kit/",
-      Tetra::AntCommand
-    )
-
-    subcommand(
-      "finish",
-      "Ends the current dry-run",
-      Tetra::FinishCommand
+      Tetra::AntSubcommand
     )
 
     subcommand(
       "generate-kit",
       "Create or refresh the kit spec and archive files",
-      Tetra::GenerateKitCommand
+      Tetra::GenerateKitSubcommand
     )
 
     subcommand(
       "generate-script",
       "Create or refresh the package build.sh file",
-      Tetra::GenerateScriptCommand
+      Tetra::GenerateScriptSubcommand
     )
 
     subcommand(
       "generate-archive",
       "Create or refresh the package tarball",
-      Tetra::GenerateArchiveCommand
+      Tetra::GenerateArchiveSubcommand
     )
 
     subcommand(
       "generate-spec",
       "Create or refresh the package spec file",
-      Tetra::GenerateSpecCommand
+      Tetra::GenerateSpecSubcommand
     )
 
     subcommand(
       "generate-all",
       "Create or refresh all specs, archives, scripts",
-      Tetra::GenerateAllCommand
+      Tetra::GenerateAllSubcommand
     )
 
     subcommand(
       "move-jars-to-kit",
       "Locates jars in src/ and moves them to kit/",
-      Tetra::MoveJarsToKitCommand
-    )
-
-    subcommand(
-      "download-maven-source-jars",
-      "Attempts to download Maven kit/ sources",
-      Tetra::DownloadMavenSourceJarsCommand
+      Tetra::MoveJarsToKitSubcommand
     )
 
     subcommand(
       "get-pom",
       "Retrieves a pom file",
-      Tetra::GetPomCommand
-    )
-
-    subcommand(
-      "get-source",
-      "Attempts to retrieve a project's sources",
-      Tetra::GetSourceCommand
-    )
-
-    subcommand(
-      "list-kit-missing-sources",
-      "Locates jars in kit/ that have no source files",
-      Tetra::ListKitMissingSourcesCommand
+      Tetra::GetPomSubcommand
     )
   end
 end