tetra 1.2.2 → 2.0.0

data/lib/tetra/project_initer.rb

@@ -0,0 +1,90 @@
+# encoding: UTF-8
+
+module Tetra
+  # takes care of intiializing a tetra project
+  module ProjectIniter
+    include Logging
+
+    # path of the project template files
+    TEMPLATE_PATH = File.join(File.dirname(__FILE__), "..", "template")
+
+    # includers get class methods defined in ClassMethods
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+    # class methods container
+    module ClassMethods
+      # returns true if the specified directory is a valid tetra project
+      def project?(dir)
+        Tetra::Logger.instance.debug "Checking for tetra project: #{dir}, contents: #{Dir.new(dir).to_a}"
+        File.directory?(File.join(dir, "src")) &&
+          File.directory?(File.join(dir, "kit")) &&
+          File.directory?(File.join(dir, ".git"))
+      end
+
+      # inits a new project directory structure
+      def init(dir, include_bundled_software = true)
+        Dir.mkdir(dir)
+        Dir.chdir(dir) do
+          git = Tetra::Git.new(".")
+
+          git.init
+
+          FileUtils.mkdir_p("src")
+          FileUtils.mkdir_p("kit")
+
+          # populate the project with templates and commit it
+          project = Project.new(".")
+
+          project.template_files(include_bundled_software).each do |source, destination|
+            FileUtils.cp_r(File.join(TEMPLATE_PATH, source), destination)
+          end
+
+          git.commit_directories(["."], "Template files added")
+        end
+      end
+    end
+
+    # 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" => "."
+      }
+
+      if include_bundled_software
+        Dir.chdir(TEMPLATE_PATH) do
+          Dir.glob(File.join("bundled", "*")).each do |file|
+            result[file] = "kit"
+          end
+        end
+      end
+
+      result
+    end
+
+    # adds a source archive at the project, both in original and unpacked forms
+    def commit_source_archive(file, message)
+      from_directory do
+        result_dir = File.join(packages_dir, name)
+        FileUtils.mkdir_p(result_dir)
+
+        result_path = File.join(result_dir, File.basename(file))
+        FileUtils.cp(file, result_path)
+        @git.commit_file(result_path, "Source archive added")
+
+        unarchiver = if file =~ /\.zip$/
+                       Tetra::Unzip.new
+                     else
+                       Tetra::Tar.new
+                     end
+
+        Dir.glob(File.join("src", "*")).each { |f| FileUtils.rm_rf(f) }
+        unarchiver.decompress(file, "src")
+        commit_sources(message, true)
+      end
+    end
+  end
+end

data/lib/tetra/ui/change_sources_subcommand.rb

@@ -0,0 +1,32 @@
+# encoding: UTF-8
+
+module Tetra
+  # tetra change-sources
+  class ChangeSourcesSubcommand < Tetra::Subcommand
+    parameter "[SOURCE_ARCHIVE]", "new source tarball or zipfile"
+    parameter "[MESSAGE]", "a short change description", default: "Sources changed"
+    option %w(-n --no-archive), :flag, "use current src/ contents instead of an archive (see SPECIAL_CASES.md)",
+           default: false
+
+    def execute
+      if source_archive.nil? && no_archive? == false
+        signal_usage_error "please specify a source archive file or use \"--no-archive\" (see SPECIAL_CASES.md)."
+      end
+
+      checking_exceptions do
+        project = Tetra::Project.new(".")
+        ensure_dry_running(:is_not_in_progress, project) do
+          if no_archive? == false
+            project.commit_source_archive(File.expand_path(source_archive), message)
+            puts "New sources committed."
+            puts "Please delete any stale source archives from packages/ before proceeding."
+          else
+            project.commit_sources(message, true)
+            puts "New sources committed."
+            puts "Please copy source archive(s) corresponding to src/ in packages/ before proceeding."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tetra/ui/dry_run_subcommand.rb

@@ -7,10 +7,11 @@ module Tetra
       checking_exceptions do
         project = Tetra::Project.new(".")
 
-        if project.src_patched? && !project.first_dry_run
-          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"
+        if project.src_patched?
+          puts "Changes detected in src/, please use:"
+          puts " \"tetra patch\" to include those changes in the package as a patch file"
+          puts " \"tetra change-sources\" to completely swap the source archive."
+          puts "Dry run not started."
         else
           project.dry_run
           puts "Dry-run started in a new bash shell."

data/lib/tetra/ui/generate_all_subcommand.rb

@@ -14,8 +14,6 @@ module Tetra
 
           GenerateScriptSubcommand.new(@invocation_path).execute
 
-          GenerateArchiveSubcommand.new(@invocation_path).execute
-
           command = GenerateSpecSubcommand.new(@invocation_path)
           command.filter = filter
           command.pom = pom

data/lib/tetra/ui/generate_spec_subcommand.rb

@@ -20,6 +20,7 @@ module Tetra
           result_path, conflict_count = package.to_spec
           print_generation_result(project, result_path, conflict_count)
           puts "Warning: #{pom} not found, some spec fields will be left blank" unless File.file?(pom)
+          puts "Warning: source archive not found, package will not build" unless project.src_archive
         end
       end
     end

data/lib/tetra/ui/init_subcommand.rb

@@ -3,12 +3,33 @@
 module Tetra
   # tetra init
   class InitSubcommand < Tetra::Subcommand
+    parameter "PACKAGE_NAME", "name of the package to create"
+    parameter "[SOURCE_ARCHIVE]", "source tarball or zipfile"
+    option %w(-n --no-archive), :flag, "create a project without a source archive (see SPECIAL_CASES.md)",
+           default: false
+
     def execute
       checking_exceptions do
-        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\""
+        if source_archive.nil? && no_archive? == false
+          signal_usage_error "please specify a source archive file or use \"--no-archive\" (see SPECIAL_CASES.md)."
+        end
+        if !source_archive.nil? && !File.readable?(source_archive)
+          signal_usage_error "#{source_archive} is not a file or it is not readable."
+        end
+
+        Tetra::Project.init(package_name)
+        project = Tetra::Project.new(package_name)
+        puts "Project inited in #{package_name}/."
+
+        if source_archive
+          puts "Decompressing sources..."
+          project.commit_source_archive(File.expand_path(source_archive), "Inital sources added from archive")
+          puts "Sources decompressed in #{package_name}/src/, original archive copied in #{package_name}/packages/."
+        else
+          puts "Use \"tetra change-sources\" to add sources to this project."
+        end
+        puts "Please add any other precompiled build dependency to kit/."
+        puts "When you are ready to test a build, use \"tetra dry-run\" from the project directory"
       end
     end
   end

data/lib/tetra/ui/main.rb

@@ -27,12 +27,6 @@ module Tetra
       Tetra::GenerateScriptSubcommand
     )
 
-    subcommand(
-      "generate-archive",
-      "Create or refresh the package tarball",
-      Tetra::GenerateArchiveSubcommand
-    )
-
     subcommand(
       "generate-spec",
       "Create or refresh the package spec file",
@@ -51,6 +45,12 @@ module Tetra
       Tetra::PatchSubcommand
     )
 
+    subcommand(
+      "change-sources",
+      "Swaps the sources for this package with new ones",
+      Tetra::ChangeSourcesSubcommand
+    )
+
     subcommand(
       "move-jars-to-kit",
       "Locates jars in src/ and moves them to kit/",

data/lib/tetra/ui/patch_subcommand.rb

@@ -3,14 +3,14 @@
 module Tetra
   # tetra patch
   class PatchSubcommand < Tetra::Subcommand
-    option %w(-n --new-tarball), :flag, "suppress patch creation, roll all changes so far in the tarball"
     parameter "[MESSAGE]", "a short patch description", default: "Sources updated"
 
     def execute
       checking_exceptions do
         project = Tetra::Project.new(".")
         ensure_dry_running(:is_not_in_progress, project) do
-          project.commit_sources(message, new_tarball?)
+          project.commit_sources(message, false)
+          puts "Patch recorded, use \"tetra generate-spec\" to update the specfile"
         end
       end
     end

data/lib/tetra/ui/subcommand.rb

@@ -95,7 +95,7 @@ module Tetra
     rescue Errno::EEXIST => e
       $stderr.puts e
     rescue NoProjectDirectoryError => e
-      $stderr.puts "#{e.directory} is not a tetra project directory, see tetra init"
+      $stderr.puts "#{e.directory} is not a tetra project directory, see \"tetra init\""
     rescue GitAlreadyInitedError
       $stderr.puts "This directory is already a tetra project"
     rescue ExecutionFailed => e

data/lib/tetra/version.rb

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

data/spec/lib/coarse/dry_run_subcommand_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe "`tetra dry-run`", type: :aruba do
+  it "does not start a dry-run if init has not run yet" do
+    run_simple("tetra dry-run")
+
+    expect(stderr_from("tetra dry-run")).to include("is not a tetra project directory")
+  end
+
+  it "does a dry-run build" do
+    run_simple("tetra init --no-archive mypackage")
+    cd("mypackage")
+
+    run_interactive("tetra dry-run")
+    type("echo ciao")
+    type("echo ciao > ciao.jar")
+    type("\u{0004}") # ^D (Ctrl+D), terminates bash with exit status 0
+
+    expect(all_output).to include("Dry-run started")
+    expect(all_output).to include("ciao")
+    expect(all_output).to include("Dry-run finished")
+
+    # check that markers were written in git repo
+    run_simple("git rev-list --format=%B --max-count=1 HEAD~")
+    expect(stdout_from("git rev-list --format=%B --max-count=1 HEAD~")).to include("tetra: dry-run-started")
+
+    run_simple("git rev-list --format=%B --max-count=1 HEAD")
+    expect(stdout_from("git rev-list --format=%B --max-count=1 HEAD")).to include("tetra: dry-run-finished")
+    expect(stdout_from("git rev-list --format=%B --max-count=1 HEAD")).to include("tetra: build-script-line: echo ciao")
+  end
+end

data/spec/lib/coarse/generate_all_subcommand_spec.rb

@@ -0,0 +1,128 @@
+require "spec_helper"
+
+describe "`tetra generate-all`", type: :aruba do
+  it "generates specs and tarballs for a sample package, source archive workflow" do
+    archive_contents = File.read(File.join("spec", "data", "commons-collections-3.2.1-src.zip"))
+    write_file("commons-collections.zip", archive_contents)
+
+    # init project
+    run_simple("tetra init commons-collections commons-collections.zip")
+    cd(File.join("commons-collections", "src", "commons-collections-3.2.1-src"))
+
+    # first dry-run, all normal
+    @aruba_timeout_seconds = 120
+    run_interactive("tetra dry-run --very-very-verbose")
+    type("mvn package -DskipTests")
+    type("\u{0004}") # ^D (Ctrl+D), terminates bash with exit status 0
+
+    expect(all_output).to include("[INFO] BUILD SUCCESS")
+    expect(all_output).to include("Checking for tetra project")
+
+    # first generate-all, all normal
+    run_simple("tetra generate-all")
+
+    expect(output_from("tetra generate-all")).to include("commons-collections-kit.spec generated")
+    expect(output_from("tetra generate-all")).to include("commons-collections-kit.tar.xz generated")
+    expect(output_from("tetra generate-all")).to include("build.sh generated")
+    expect(output_from("tetra generate-all")).to include("commons-collections.spec generated")
+
+    # patch one file
+    append_to_file("README.txt", "patched by tetra test")
+
+    # second dry-run fails: sources changed
+    run_simple("tetra dry-run")
+    expect(output_from("tetra dry-run")).to include("Changes detected in src")
+    expect(output_from("tetra dry-run")).to include("Dry run not started")
+
+    # run patch
+    run_simple("tetra patch")
+
+    # third dry-run succeeds with patch
+    run_interactive("tetra dry-run")
+    type("mvn package -DskipTests")
+    type("\u{0004}") # ^D (Ctrl+D), terminates bash with exit status 0
+
+    expect(all_output).to include("[INFO] BUILD SUCCESS")
+
+    run_simple("tetra generate-all --very-very-verbose")
+
+    expect(output_from("tetra generate-all --very-very-verbose")).to include("commons-collections-kit.spec generated")
+    expect(output_from("tetra generate-all --very-very-verbose")).to include("commons-collections-kit.tar.xz generated")
+    expect(output_from("tetra generate-all --very-very-verbose")).to include("build.sh generated")
+    expect(output_from("tetra generate-all --very-very-verbose")).to include("commons-collections.spec generated")
+    expect(output_from("tetra generate-all --very-very-verbose")).to include("0001-Sources-updated.patch generated")
+
+    with_file_content("../../packages/commons-collections/commons-collections.spec") do |content|
+      expect(content).to include("0001-Sources-updated.patch")
+    end
+  end
+
+  it "generates specs and tarballs for a sample package, manual source workflow" do
+    archive_contents = File.read(File.join("spec", "data", "commons-collections-3.2.1-src.zip"))
+    write_file("commons-collections.zip", archive_contents)
+
+    # init project
+    run_simple("tetra init -n commons-collections")
+
+    # add sources
+    run_simple("unzip commons-collections.zip -d commons-collections/src")
+
+    cd("commons-collections")
+
+    # first dry-run fails: sources changed
+    run_simple("tetra dry-run")
+    expect(output_from("tetra dry-run")).to include("Changes detected in src")
+    expect(output_from("tetra dry-run")).to include("Dry run not started")
+
+    # run change-sources
+    run_simple("tetra change-sources ../commons-collections.zip")
+    expect(output_from("tetra change-sources ../commons-collections.zip")).to include("New sources committed")
+
+    # second dry-run, all normal
+    cd(File.join("src", "commons-collections-3.2.1-src"))
+    @aruba_timeout_seconds = 120
+    run_interactive("tetra dry-run")
+    type("mvn package -DskipTests")
+    type("\u{0004}") # ^D (Ctrl+D), terminates bash with exit status 0
+
+    expect(all_output).to include("[INFO] BUILD SUCCESS")
+
+    # first generate-all, all normal
+    run_simple("tetra generate-all")
+
+    expect(output_from("tetra generate-all")).to include("commons-collections-kit.spec generated")
+    expect(output_from("tetra generate-all")).to include("commons-collections-kit.tar.xz generated")
+    expect(output_from("tetra generate-all")).to include("build.sh generated")
+    expect(output_from("tetra generate-all")).to include("commons-collections.spec generated")
+
+    # patch one file
+    append_to_file("README.txt", "patched by tetra test")
+
+    # second dry-run fails: sources changed
+    run_simple("tetra dry-run")
+    expect(output_from("tetra dry-run")).to include("Changes detected in src")
+    expect(output_from("tetra dry-run")).to include("Dry run not started")
+
+    # run patch
+    run_simple("tetra patch")
+
+    # third dry-run succeeds with patch
+    run_interactive("tetra dry-run")
+    type("mvn package -DskipTests")
+    type("\u{0004}") # ^D (Ctrl+D), terminates bash with exit status 0
+    expect(all_output).to include("[INFO] BUILD SUCCESS")
+
+    run_simple("tetra generate-all")
+
+    expect(output_from("tetra generate-all")).to include("commons-collections-kit.spec generated")
+    expect(output_from("tetra generate-all")).to include("commons-collections-kit.tar.xz generated")
+    expect(output_from("tetra generate-all")).to include("build.sh generated")
+    expect(output_from("tetra generate-all")).to include("commons-collections.spec generated")
+    expect(output_from("tetra generate-all")).to include("0001-Sources-updated.patch generated")
+
+    with_file_content("../../packages/commons-collections/commons-collections.spec") do |content|
+      expect(content).to include("0001-Sources-updated.patch")
+      expect(content).to include("commons-collections.zip")
+    end
+  end
+end

data/spec/lib/coarse/generate_spec_subcommand_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe "`tetra generate-spec`", type: :aruba do
+  it "outputs a warning if source files are not found" do
+    archive_contents = File.read(File.join("spec", "data", "commons-collections-3.2.1-src.zip"))
+    write_file("commons-collections.zip", archive_contents)
+
+    run_simple("tetra init --no-archive commons-collections")
+    cd("commons-collections")
+
+    cd("src")
+    run_simple("unzip ../../commons-collections.zip")
+    cd("commons-collections-3.2.1-src")
+
+    run_simple("tetra change-sources --no-archive")
+    expect(output_from("tetra change-sources --no-archive")).to include("New sources committed")
+
+    @aruba_timeout_seconds = 120
+    run_interactive("tetra dry-run")
+    type("mvn package -DskipTests")
+    type("\u{0004}") # ^D (Ctrl+D), terminates bash with exit status 0
+
+    expect(all_output).to include("[INFO] BUILD SUCCESS")
+
+    run_simple("tetra generate-spec")
+
+    expect(output_from("tetra generate-spec")).to include("Warning: source archive not found, package will not build")
+  end
+end