tetra 0.40.0

data/lib/template/kit/CONTENTS

@@ -0,0 +1,8 @@
+This directory contains all binary files needed to build a tetra project's
+packages.
+
+These files should only be used during build and should not be installed
+on users' systems.
+
+Some generally useful configuration files are also placed here (eg.
+m2/settings.xml for Maven builds).

data/lib/template/kit/jars/CONTENTS

@@ -0,0 +1 @@
+This directory contains jars moved here from source archives.

data/lib/template/kit/m2/settings.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ | This is the configuration file used by default by `tetra mvn`.
+ | Feel free to add settings here if any are needed for tetra dry runs.
+ |-->
+<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
+</settings>

data/lib/template/output/CONTENTS

@@ -0,0 +1,3 @@
+tetra will save all output files it generates (specs, archives, etc.) here.
+
+Feel free to use this directory as an OBS project root.

data/lib/template/package.spec

@@ -0,0 +1,65 @@
+#
+# spec file for "<%= 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.
+
+# Please submit bugfixes or comments via http://bugs.opensuse.org/
+#
+
+Name:           <%= name %>
+Version:        <%= version %>
+Release:        1
+License:        <%= license %>
+Summary:        <%= summary %>
+Url:            <%= url %>
+Group:          Development/Libraries/Java
+Source0:        %{name}.tar.xz
+Source1:        build.sh
+BuildRoot:      %{_tmppath}/%{name}-%{version}-build
+BuildRequires:  xz
+BuildRequires:  java-devel
+BuildRequires:  <%= project_name %>-kit >= <%= project_version %>
+BuildArch:      noarch
+Provides:       mvn(<%= group_id %>:<%= artifact_id %>) == <%= version %>
+Requires:       java
+<% runtime_dependency_ids.each do |dependency_id| %>
+Requires:       mvn(<%= dependency_id[0] %>:<%= dependency_id[1] %>) <% if dependency_id[3] != nil %>==<%= dependency_id[3] %><% end %>
+<% end %>
+
+%description
+<%=
+  description
+%>
+
+%prep
+%setup -q -c -n src/<%= name %>
+cp -f %{SOURCE1} .
+cp -Rf %{_datadir}/tetra/<%= project_name %>-kit ../../kit
+
+%build
+cd ../../
+sh src/<%= name %>/build.sh
+
+%install
+export NO_BRP_CHECK_BYTECODE_VERSION=true
+mkdir -p %{buildroot}%{_javadir}
+<% outputs.each do |output| %>
+cp -a <%= output %> %{buildroot}%{_javadir}/<%= File.basename(output) %>
+<% end %>
+
+%files
+%defattr(-,root,root)
+<% outputs.each do |output| %>
+%{_javadir}/<%= File.basename(output) %>
+<% end %>
+
+%changelog

data/lib/template/src/CONTENTS

@@ -0,0 +1,6 @@
+For each package you want to create, you should create a subdirectory here
+named after the package name itself.
+
+In that directory, place all the source files "verbatim" (as checked out from
+the original source repository, ideally in a different subdirectory)
+plus any additional files you might need for the build.

data/lib/tetra.rb

@@ -0,0 +1,63 @@
+# encoding: UTF-8
+
+# ruby standard library
+require "digest/sha1"
+require "English"
+require "erb"
+require "find"
+require "forwardable"
+require "logger"
+require "open-uri"
+require "pathname"
+require "singleton"
+require "text"
+
+# third party libraries
+require "clamp"
+require "json"
+require "nokogiri"
+require "rest_client"
+require "zip"
+
+# internal, backend
+require "tetra/version"
+require "tetra/logger"
+require "tetra/template_manager"
+require "tetra/git"
+require "tetra/script_generator"
+require "tetra/project"
+require "tetra/pom"
+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_spec_adapter"
+require "tetra/package_spec_adapter"
+require "tetra/spec_generator"
+require "tetra/archiver"
+require "tetra/kit_checker"
+
+# 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_archive"
+require "tetra/commands/generate_kit_spec"
+require "tetra/commands/generate_package_archive"
+require "tetra/commands/generate_package_script"
+require "tetra/commands/generate_package_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/main"

data/lib/tetra/ant_runner.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+module Tetra
+  # runs Ant with tetra-specific options
+  class AntRunner < KitRunner
+    include Logging
+
+    # runs ant in a subprocess
+    def ant(options)
+      run_executable("#{get_ant_commandline(@project.full_path)} #{options.join(" ")}")
+    end
+
+    # returns a command line for running Ant from the specified
+    # prefix
+    def get_ant_commandline(prefix)
+      executable = find_executable("ant")
+
+      if !executable.nil?
+        ant_path = File.join(prefix, executable)
+
+        "#{ant_path}"
+      else
+        fail ExecutableNotFoundError, "ant"
+      end
+    end
+  end
+end

data/lib/tetra/archiver.rb

@@ -0,0 +1,95 @@
+# encoding: UTF-8
+
+module Tetra
+  # generates file archives that accompany spec files
+  class 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))
+      end
+    end
+  end
+end

data/lib/tetra/commands/ant.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+
+module Tetra
+  # tetra ant
+  class AntCommand < Tetra::BaseCommand
+    parameter "[ANT OPTIONS] ...", "ant options", attribute_name: "dummy"
+
+    # override parsing in order to pipe everything to mvn
+    # rubocop:disable TrivialAccessors
+    def parse(args)
+      @options = args
+    end
+
+    def execute
+      checking_exceptions do
+        project = Tetra::Project.new(".")
+        ensure_dry_running(true, project) do
+          Tetra::AntRunner.new(project).ant(@options)
+        end
+      end
+    end
+  end
+end

data/lib/tetra/commands/base.rb

@@ -0,0 +1,89 @@
+# encoding: UTF-8
+
+module Tetra
+  # implements common options and utility methods
+  class BaseCommand < Clamp::Command
+    include Logging
+
+    # Options available to all tetra commands
+    option %w(-v --verbose), :flag, "verbose output"
+    option ["--very-verbose"], :flag, "very verbose output"
+    option ["--very-very-verbose"], :flag, "very very verbose output"
+
+    # verbosity handlers
+    def very_very_verbose=(flag)
+      configure_log_level(verbose?, very_verbose?, flag)
+    end
+
+    def very_verbose=(flag)
+      configure_log_level(verbose?, flag, very_very_verbose?)
+    end
+
+    def verbose=(flag)
+      configure_log_level(flag, very_verbose?, very_very_verbose?)
+    end
+
+    # maps verbosity options to log level
+    def configure_log_level(v, vv, vvv)
+      if vvv
+        log.level = ::Logger::DEBUG
+      elsif vv
+        log.level = ::Logger::INFO
+      elsif v
+        log.level = ::Logger::WARN
+      else
+        log.level = ::Logger::ERROR
+      end
+    end
+
+    # prints an error message and exits unless there is a dry-run in progress
+    def ensure_dry_running(state, project)
+      if project.dry_running? == state
+        yield
+      else
+        if state == true
+          puts "Please start a dry-run first, use \"tetra dry-run\""
+        else
+          puts "Please finish or abort this dry-run first, use \"tetra finish\" or \"tetra finish --abort\""
+        end
+      end
+    end
+
+    # outputs output of a file generation
+    def print_generation_result(project, result_path, conflict_count = 0)
+      puts "#{format_path(result_path, project)} generated"
+      puts "Warning: #{conflict_count} unresolved conflicts" if conflict_count > 0
+    end
+
+    # generates a version of path relative to the current directory
+    def format_path(path, project)
+      full_path = (
+        if Pathname.new(path).relative?
+          File.join(project.full_path, path)
+        else
+          path
+        end
+      )
+      Pathname.new(full_path).relative_path_from(Pathname.new(Dir.pwd))
+    end
+
+    # handles most fatal exceptions
+    def checking_exceptions
+      yield
+    rescue Errno::EACCES => e
+      $stderr.puts e
+    rescue Errno::ENOENT => e
+      $stderr.puts e
+    rescue Errno::EEXIST => e
+      $stderr.puts e
+    rescue NoProjectDirectoryError => e
+      $stderr.puts "#{e.directory} is not a tetra project directory, see tetra init"
+    rescue NoPackageDirectoryError => e
+      $stderr.puts "#{e.directory} is not a tetra package directory, see README"
+    rescue GitAlreadyInitedError
+      $stderr.puts "This directory is already a tetra project"
+    rescue ExecutableNotFoundError => e
+      $stderr.puts "Executable #{e.executable} not found in kit/ or any of its subdirectories"
+    end
+  end
+end

data/lib/tetra/commands/download_maven_source_jars.rb

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+
+module Tetra
+  # tetra download-maven-source-jars
+  class DownloadMavenSourceJarsCommand < Tetra::BaseCommand
+    def execute
+      checking_exceptions do
+        project = Tetra::Project.new(".")
+        source_getter = Tetra::SourceGetter.new
+
+        ensure_dry_running(false, project) do
+          puts "Getting sources from Maven..."
+          succeeded, failed = source_getter.get_maven_source_jars(project)
+
+          puts "\n**SUMMARY**\n"
+          puts "Sources found for:"
+          succeeded.each do |path|
+            puts " #{format_path(path, project)}"
+          end
+
+          puts "\nSources not found for:"
+          failed.each do |path|
+            puts " #{format_path(path, project)}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tetra/commands/dry_run.rb

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+
+module Tetra
+  # tetra dry-run
+  class DryRunCommand < Tetra::BaseCommand
+    def execute
+      checking_exceptions do
+        if Tetra::Project.new(".").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 finish\"."
+          puts "If the build does not succeed use \"tetra finish --abort\" to restore files."
+        end
+      end
+    end
+  end
+end