tetra 0.40.0 → 0.41.0

data/.gitignore

@@ -23,5 +23,5 @@ _yardoc
 doc/
 
 # integration test files
-integration-tests/galaxy
+integration-tests/commons
 

data/Gemfile

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 source "http://rubygems.org"
 
 # See tetra.gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    tetra (0.40.0)
+      clamp
+      json
+      nokogiri
+      rest-client
+      rubyzip (>= 1.0)
+      text
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    clamp (0.6.3)
+    diff-lcs (1.2.5)
+    json (1.8.1)
+    mime-types (2.3)
+    mini_portile (0.6.0)
+    netrc (0.7.7)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    rake (10.3.2)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+    rubyzip (1.1.6)
+    text (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec
+  tetra!

data/MOTIVATION.md

@@ -11,13 +11,19 @@ A typical example is packaging any software built by Maven on SUSE distros. A nu
 * Maven often uses multiple versions of a same library or plugin during the same build. Usually distros do not accept more than one version of any given library to reduce maintenance work;
 * Maven requires itself in order to build. To be more exact, Maven needs Nexus, which in turn needs Maven and Nexus. To be more exact, its build dependency graph is a very complicated mess with lots of cycles that have to be broken manually.
 
-The current solution in openSUSE is having the packager handle those differences, but this limits the amount of software the community is able to package due to the high effort required to overcome them.
+## Existing solutions
 
-The Fedora community is experimenting with another set of tools, [XMvn](http://mizdebsk.fedorapeople.org/xmvn/site/), which goals are similar to `tetra`'s. 
+In the openSUSE community, it is a packager's duty to handle those differences, but this limits the amount of software the community is able to package due to the high effort required to overcome them.
+
+The Fedora community uses another set of tools, [XMvn](http://mizdebsk.fedorapeople.org/xmvn/site/), which goals are similar to `tetra`'s. They are limited to Maven, though.
+
+The Debian community has [various tools](https://wiki.debian.org/Java/Packaging), and among those one that automatically patches `pom.xml` Maven files. The downside is that those files will be different from the original upstream's, so they will have to be kept up to date.
+
+The Arch community [basically ignores the problem](https://wiki.archlinux.org/index.php/Java_Package_Guidelines): "You do not need to compile Java applications from source.".
 
 ## Kit rationale
 
-`tetra` simplifies the packaging process mostly because of its use of a binary blob package that contains all build time dependencies for a set of packages called a **kit**.
+`tetra` simplifies the packaging process mostly because of its use of packaged binary blobs that contain all build time dependencies for a set of packages. This is called a **kit**.
 
 Building software from a binary blob is unusual for Linux distros, and it surely has some drawbacks. It is anyway believed that benefits outweigh them, in fact using prebuilt software:
 

data/README.md

@@ -1,10 +1,10 @@
 # tetra – builds RPMs for Java software
 
-`tetra` is a set of tools to help you build RPM packages for Java projects.
+`tetra` is a tool to help you build RPM packages for Java projects.
 
-Packaging of Java projects is sometimes hard because build tools like Maven partially overlap with distro tools like RPM in functionality.
+Packaging of Java projects is sometimes hard - mainly because build tools like Maven partially overlap with distro ones like RPM.
 
-This tool's goal is to drastically simplifies packaging.
+See [MOTIVATION.md](MOTIVATION.md) for further information.
 
 ## Installation
 
@@ -31,7 +31,7 @@ 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. See [MOTIVATION.md](MOTIVATION.md) for further information.
+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.
 
 ## A commons-collections walkthrough
 
@@ -71,7 +71,7 @@ Finally, generate build scripts, spec files and tarballs in the `output/` direct
 
     tetra generate-all
 
-Note that `tetra` will generate files for the commons-collections package and for the binary-only myproject-kit package, which is a special container of all build-time dependencies (basically, the `kit/` folder). This will be shared among all packages you might add to your `tetra` project.
+Note that `tetra` will generate files for the commons-collections package and all binary-only build-time dependencies (basically, the `kit/` folder). This will be shared among all packages you might add to your `tetra` project.
 
 ## In-depth information
 

data/SPECIAL_CASES.md

@@ -14,11 +14,9 @@ You can do any manual changes to spec and build.sh files and regenerate them lat
 * `tetra generate-package-archive`: (re)generates a package tarball;
 * `tetra generate-package-spec`: (re)generates a package spec;
 
-Note that, by default, `generate-kit-archive` will generate additional "diff" tar.xz files instead of rewriting the whole archive - this will result in faster uploads if you use OBS (see below). You can use the `--whole` option to regenerate a single complete archive.
-
 ## Kit sources
 
-Your kit is basically a binary blob. If its sources are needed for proper packaging, for example to comply with the GPL, some extra steps are needed.
+Your kit packages are basically binary blobs. If its sources are needed for proper packaging, for example to comply with the GPL, some extra steps are needed.
 
 If you use Maven, most (~90%) sources can be automatically downloaded:
 

data/integration-tests/{commons.sh → build-commons.sh}

@@ -1,12 +1,12 @@
 #!/bin/bash
 
-# A crude integration test that builds commons-collections
+# A crude integration test that builds some Apache Commons libraries
 
 set -e
 
-rm -Rf galaxy
-mkdir galaxy
-cd galaxy
+rm -Rf commons
+mkdir commons
+cd commons
 tetra init
 
 cd src
@@ -27,7 +27,19 @@ cd src/commons-collections/commons-collections-3.2.1-src/
 tetra mvn package -DskipTests
 tetra finish
 
-tetra generate-all
+tetra generate-kit-archive
+tetra generate-kit-spec
+tetra generate-package-archive
+tetra generate-package-spec
+# simulate tetra generate-package-script
+cat >../../../output/commons-collections/build.sh <<"EOF"
+#!/bin/bash
+PROJECT_PREFIX=`readlink -e .`
+cd .
+cd src/commons-collections/commons-collections-3.2.1-src/
+$PROJECT_PREFIX/kit/apache-maven-3.1.1/bin/mvn -Dmaven.repo.local=$PROJECT_PREFIX/kit/m2 -s$PROJECT_PREFIX/kit/m2/settings.xml -o package -DskipTests
+EOF
+
 cd ../../..
 
 cd src
@@ -44,9 +56,17 @@ tetra finish
 
 tetra generate-kit-archive
 tetra generate-kit-spec
-tetra generate-package-script
 tetra generate-package-archive
 tetra generate-package-spec
+# simulate tetra generate-package-script
+cat >../../../output/commons-fileupload/build.sh <<"EOF"
+#!/bin/bash
+PROJECT_PREFIX=`readlink -e .`
+cd .
+cd src/commons-fileupload/commons-fileupload-1.3-src/
+$PROJECT_PREFIX/kit/apache-maven-3.1.1/bin/mvn -Dmaven.repo.local=$PROJECT_PREFIX/kit/m2 -s$PROJECT_PREFIX/kit/m2/settings.xml -o package -DskipTests
+EOF
+
 cd ../../..
 
 

data/integration-tests/build-obs.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+# A crude integration test that tries OBS building
+# assumes an OpenSUSE host is set up with passwordless SSH access
+# assumes this host has osc installed and properly configured in sudoers
+# assumes that a project directory exists
+
+set -e
+
+OBS_HOST=obs-client
+OBS_PROJECT_DIR=/home/silvio/obs/home\:SilvioMoioli
+
+scp -r commons/output/* $OBS_HOST:/$OBS_PROJECT_DIR
+ssh -t $OBS_HOST <<EOF
+  cd $OBS_PROJECT_DIR/commons-kit/ &&\
+  osc build -k../rpms -p../rpms &&\
+  cd ../commons-collections/ &&\
+  osc build -k../rpms -p../rpms &&\
+  cd ../commons-fileupload/ &&\
+  osc build -k../rpms -p../rpms
+EOF

data/lib/template/kit_item.spec

@@ -0,0 +1,53 @@
+#
+# spec file for a build-time dependency of project "<%= project.name %>"
+#
+# Copyright (c) <%= Time.now.year %> <%= Etc.getlogin %>
+#
+# All modifications and additions to the file contributed by third parties
+# remain the property of their copyright owners, unless otherwise agreed
+# upon. The license for this file, and modifications and additions to the
+# file, is the same license as for the pristine package itself (unless the
+# license for the pristine package is not an Open Source License, in which
+# case the license is the MIT License). An "Open Source License" is a
+# license that conforms to the Open Source Definition (Version 1.9)
+# published by the Open Source Initiative.
+
+Name:           <%= package_name %>
+Version:        1
+Release:        1
+License:        SUSE-NonFree
+Summary:        Build-time dependency of project "<%= project.name %>"
+Url:            https://github.com/SilvioMoioli/tetra
+Group:          Development/Libraries/Java
+Source0:        %{name}.tar.xz
+BuildRoot:      %{_tmppath}/%{name}-%{version}-build
+BuildArch:      noarch
+BuildRequires:  xz
+Provides:       <%= provides_symbol %> == <%= provides_version %>
+<% if conflicts %>
+Conflicts:      otherproviders(<%= provides_symbol %>)
+<% end %>
+
+%description
+This package has been automatically created by tetra in order to
+satisfy build time dependencies of Java packages.
+It should not be used except for rebuilding other packages,
+thus it should never be installed on end users' systems.
+
+%prep
+%setup -q -c
+
+%build
+# nothing to do, precompiled by design
+
+%install
+export NO_BRP_CHECK_BYTECODE_VERSION=true
+install -d -m 0755 %{buildroot}%{_datadir}/tetra/<%= install_dir %>
+cp -a * %{buildroot}%{_datadir}/tetra/<%= install_dir %>
+
+%files
+%defattr(-,root,root)
+%{_datadir}/tetra
+%{_datadir}/tetra/<%= install_dir %>
+
+%changelog

data/lib/template/package.spec

@@ -27,7 +27,9 @@ Source1:        build.sh
 BuildRoot:      %{_tmppath}/%{name}-%{version}-build
 BuildRequires:  xz
 BuildRequires:  java-devel
-BuildRequires:  <%= project_name %>-kit >= <%= project_version %>
+<% kit_items.each do |item| %>
+BuildRequires:  <%= item.provides_symbol %> == <%= item.provides_version %>
+<% end %>
 BuildArch:      noarch
 Provides:       mvn(<%= group_id %>:<%= artifact_id %>) == <%= version %>
 Requires:       java
@@ -43,7 +45,7 @@ Requires:       mvn(<%= dependency_id[0] %>:<%= dependency_id[1] %>) <% if depen
 %prep
 %setup -q -c -n src/<%= name %>
 cp -f %{SOURCE1} .
-cp -Rf %{_datadir}/tetra/<%= project_name %>-kit ../../kit
+cp -Rf %{_datadir}/tetra ../../kit
 
 %build
 cd ../../

data/lib/tetra.rb

@@ -22,7 +22,6 @@ require "zip"
 # internal, backend
 require "tetra/version"
 require "tetra/logger"
-require "tetra/template_manager"
 require "tetra/git"
 require "tetra/script_generator"
 require "tetra/project"
@@ -34,10 +33,13 @@ require "tetra/source_getter"
 require "tetra/kit_runner"
 require "tetra/ant_runner"
 require "tetra/maven_runner"
-require "tetra/kit_spec_adapter"
-require "tetra/package_spec_adapter"
 require "tetra/spec_generator"
 require "tetra/archiver"
+require "tetra/maven_kit_item"
+require "tetra/jar_kit_item"
+require "tetra/glue_kit_item"
+require "tetra/kit"
+require "tetra/package"
 require "tetra/kit_checker"
 
 # internal, UI

data/lib/tetra/archiver.rb

@@ -1,94 +1,30 @@
 # encoding: UTF-8
 
 module Tetra
-  # generates file archives that accompany spec files
-  class Archiver
+  # implements a to_archive method
+  module Archiver
     include Logging
-
-    def initialize(project)
-      @project = project
-    end
-
-    # generates an archive for the kit package
-    def archive_kit(whole)
-      destination_dir = File.join(@project.full_path, "output", "#{@project.name}-kit")
-      FileUtils.mkdir_p(destination_dir)
-      file_prefix = "#{@project.name}-kit"
-      file_suffix = ".tar.xz"
-
-      @project.take_snapshot "Kit archival started"
-
-      destination_file = (
-        if whole
-          remove_stale_incremental(destination_dir, file_prefix, file_suffix)
-          archive_single("kit", File.join(destination_dir, file_prefix + file_suffix))
-        else
-          log.debug "doing incremental archive"
-          archive_incremental("kit", destination_dir, file_prefix, file_suffix, :archive_kit)
-        end
-      )
-
-      @project.take_snapshot "Kit archive generated", :archive_kit
-
-      destination_file
-    end
-
-    # generates an archive for a project's package based on its file list
-    def archive_package(name)
-      destination_dir = File.join(@project.full_path, "output", name)
-      FileUtils.mkdir_p(destination_dir)
-      destination_file = File.join(destination_dir, "#{name}.tar.xz")
-
-      archive_single(File.join("src", name), destination_file)
-    end
-
-    # archives a directory's contents to the destination file
-    def archive_single(source_directory, destination_file)
-      log.debug "creating #{destination_file}"
-      @project.from_directory source_directory do
-        `tar -cJf #{destination_file} *`
-      end
-
-      destination_file
-    end
-
-    # archives a directory's changed contents since last time archive_incremental was called
-    # uses snapshots with tag_prefix to keep track of calls to this method
-    # destination files will be file_prefix_NNNN_file_suffix
-    def archive_incremental(source_directory, destination_dir, file_prefix, file_suffix, tag_prefix)
-      @project.from_directory do
-        latest_tag_count = @project.latest_tag_count(tag_prefix)
-
-        if latest_tag_count == 0
-          archive_single(source_directory, File.join(destination_dir, file_prefix + file_suffix))
-        else
-          destination_file = File.join(destination_dir,
-                                       "#{file_prefix}_#{format("%04d", latest_tag_count)}#{file_suffix}")
-          tag = @project.latest_tag(tag_prefix)
-          log.debug "creating #{destination_file} with files newer than #{tag}"
-
-          log.debug "files that changed since then: #{@project.git.changed_files_since(tag)}"
-          list = @project.git.changed_files_since(tag).select do |file|
-            File.expand_path(file) =~ /^#{File.expand_path(source_directory)}\//
-          end.map do |file|
-            Pathname.new(file).relative_path_from Pathname.new(source_directory)
-          end
-          @project.from_directory source_directory do
-            `tar -cJf #{destination_file} #{list.join(" ")}`
-          end
-
-          destination_file
-        end
-      end
-    end
-
-    # removes any stale incremental files
-    def remove_stale_incremental(destination_dir, file_prefix, file_suffix)
-      Dir.entries(destination_dir)
-        .select { |f| f =~ /^#{file_prefix}_([0-9]+)#{file_suffix}$/ }
-        .each do |f|
-        log.debug "removing stale incremental archive #{f}"
-        File.delete(File.join(destination_dir, f))
+    # expected attributes:
+    #   project (Tetra::Project)
+    #   package_name (string)
+    #   source_dir (string)
+    #   source_paths ([string])
+    #   destination_dir (string)
+
+    # generates an archive and returns its name
+    # this will archive source_paths starting from source_dir in
+    # destination_dir + package_name + extension
+    def to_archive
+      full_destination_dir = File.join(project.full_path, "output", destination_dir)
+      FileUtils.mkdir_p(full_destination_dir)
+
+      project.from_directory(source_dir) do
+        destination_path = File.join(full_destination_dir, "#{package_name}.tar.xz")
+        log.debug "creating #{destination_path}"
+
+        `tar -cJf #{destination_path} #{source_paths.join(" ")}`
+
+        destination_path
       end
     end
   end

data/lib/tetra/commands/generate_all.rb

@@ -4,7 +4,6 @@ module Tetra
   # tetra generate-all
   class GenerateAllCommand < Tetra::BaseCommand
     option %w(-f --filter), "FILTER", "filter files to be installed by this package spec", default: "*.jar"
-    option %w(-w --whole), :flag, "recreate the whole archive (not incremental)"
     parameter "[DIRECTORY]", "path to a package directory (src/<package name>)", default: "."
     parameter "[POM]", "a package pom file path", default: "pom.xml"
 
@@ -12,25 +11,23 @@ module Tetra
       checking_exceptions do
         project = Tetra::Project.new(".")
         ensure_dry_running(false, project) do
-          package_name = project.get_package_name(directory)
+          GenerateKitArchiveCommand.new(@invocation_path).execute
 
-          result_path = Tetra::Archiver.new(project).archive_kit(whole?)
-          print_generation_result(project, result_path)
+          GenerateKitSpecCommand.new(@invocation_path).execute
 
-          result_path, conflict_count = Tetra::SpecGenerator.new(project).generate_kit_spec
-          print_generation_result(project, result_path, conflict_count)
+          script_command = GeneratePackageScriptCommand.new(@invocation_path)
+          script_command.directory = directory
+          script_command.execute
 
-          history_file = File.join(Dir.home, ".bash_history")
-          result_path, conflict_count = Tetra::ScriptGenerator.new(project, history_file)
-            .generate_build_script(package_name)
-          print_generation_result(project, result_path, conflict_count)
+          archive_command = GeneratePackageArchiveCommand.new(@invocation_path)
+          archive_command.directory = directory
+          archive_command.execute
 
-          result_path = Tetra::Archiver.new(project).archive_package package_name
-          print_generation_result(project, result_path)
-
-          result_path, conflict_count = Tetra::SpecGenerator.new(project)
-            .generate_package_spec package_name, pom, filter
-          print_generation_result(project, result_path, conflict_count)
+          archive_command = GeneratePackageSpecCommand.new(@invocation_path)
+          archive_command.filter = filter
+          archive_command.directory = directory
+          archive_command.pom = pom
+          archive_command.execute
         end
       end
     end