gjp 0.36.0 → 0.37.0

data/.gitignore

@@ -21,3 +21,7 @@ spec/data/test-project
 .yardoc
 _yardoc
 doc/
+
+# integration test files
+integration-tests/galaxy
+

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_from: .rubocop_todo.yml
+
+LineLength:
+  Max: 120
+
+StringLiterals:
+  EnforcedStyle: double_quotes

data/.rubocop_todo.yml

@@ -0,0 +1,241 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-05-23 15:40:35 +0200 using RuboCop version 0.22.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+ClassVars:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+ColonMethodCall:
+  Enabled: false
+
+# Offense count: 6
+# Cop supports --auto-correct.
+CommentIndentation:
+  Enabled: false
+
+# Offense count: 1
+CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 6
+# Cop supports --auto-correct.
+DeprecatedClassMethods:
+  Enabled: false
+
+# Offense count: 8
+Documentation:
+  Enabled: false
+
+# Offense count: 1
+DoubleNegation:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+EmptyLines:
+  Enabled: false
+
+# Offense count: 1
+EmptyLinesAroundAccessModifier:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+EmptyLinesAroundBody:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Encoding:
+  Enabled: false
+
+# Offense count: 9
+# Configuration parameters: AlignWith, SupportedStyles.
+EndAlignment:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+FormatString:
+  Enabled: false
+
+# Offense count: 4
+# Configuration parameters: MinBodyLength.
+GuardClause:
+  Enabled: false
+
+# Offense count: 27
+# Cop supports --auto-correct.
+# Configuration parameters: SupportedStyles.
+HashSyntax:
+  EnforcedStyle: hash_rockets
+
+# Offense count: 7
+# Configuration parameters: MaxLineLength.
+IfUnlessModifier:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+IndentationConsistency:
+  Enabled: false
+
+# Offense count: 15
+# Cop supports --auto-correct.
+IndentationWidth:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+LineEndConcatenation:
+  Enabled: false
+
+# Offense count: 4
+# Cop supports --auto-correct.
+MethodCallParentheses:
+  Enabled: false
+
+# Offense count: 28
+# Configuration parameters: CountComments.
+MethodLength:
+  Max: 34
+
+# Offense count: 6
+MultilineBlockChain:
+  Enabled: false
+
+# Offense count: 3
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Next:
+  Enabled: false
+
+# Offense count: 8
+# Cop supports --auto-correct.
+NilComparison:
+  Enabled: false
+
+# Offense count: 12
+# Cop supports --auto-correct.
+# Configuration parameters: IncludeSemanticChanges.
+NonNilCheck:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+PerlBackrefs:
+  Enabled: false
+
+# Offense count: 3
+# Configuration parameters: NamePrefixBlacklist.
+PredicateName:
+  Enabled: false
+
+# Offense count: 4
+# Configuration parameters: SupportedStyles.
+RaiseArgs:
+  EnforcedStyle: compact
+
+# Offense count: 2
+# Cop supports --auto-correct.
+RedundantBegin:
+  Enabled: false
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: AllowMultipleReturnValues.
+RedundantReturn:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: MaxSlashes.
+RegexpLiteral:
+  Enabled: false
+
+# Offense count: 1
+ShadowingOuterLocalVariable:
+  Enabled: false
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+SignalException:
+  Enabled: false
+
+# Offense count: 11
+# Cop supports --auto-correct.
+SpaceAfterComma:
+  Enabled: false
+
+# Offense count: 8
+# Cop supports --auto-correct.
+SpaceAroundOperators:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+SpaceBeforeBlockBraces:
+  Enabled: false
+
+# Offense count: 13
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+SpaceInsideBlockBraces:
+  Enabled: false
+
+# Offense count: 22
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SupportedStyles.
+SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+# Offense count: 4
+# Cop supports --auto-correct.
+SpecialGlobalVars:
+  Enabled: false
+
+# Offense count: 7
+Tab:
+  Enabled: false
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+TrailingBlankLines:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
+TrailingComma:
+  Enabled: false
+
+# Offense count: 45
+# Cop supports --auto-correct.
+TrailingWhitespace:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, Whitelist.
+TrivialAccessors:
+  Enabled: false
+
+# Offense count: 8
+# Cop supports --auto-correct.
+UnusedBlockArgument:
+  Enabled: false
+
+# Offense count: 6
+UselessAssignment:
+  Enabled: false
+
+# Offense count: 6
+# Cop supports --auto-correct.
+WordArray:
+  MinSize: 2

data/SPECIAL_CASES.md

@@ -68,11 +68,6 @@ Note that the kit package is needed at build time only by OBS, no end user shoul
 ## Gotchas
 
 * `gjp` internally uses `git` to keep track of files, any gjp project is actually also a `git` repo. Feel free to navigate it, you can commit, push and pull as long as the `gjp` tags are preserved. You can also delete commits and tags, effectively rewinding gjp history (just make sure to delete all tags pointing to a certain commit when you discard it);
-* if your sources come from a Git repo, be sure to remove any `.git`/`.gitignore` files, otherwise `gjp` might get confused;
-* if OBS complains that jars in your kit or package are compiled for a JDK version higher than 1.5, add the following line after `%install` to squelch the error:
-
-    export NO_BRP_CHECK_BYTECODE_VERSION=true
-
 * some Maven plugins like the Eclipse Project ones ([Tycho](https://www.eclipse.org/tycho/)) will save data in `/tmp` downloaded from the Internet and will produce errors if this data is not there during offline builds. One way to work around that is to force Java to use a kit subdirectory as `/tmp`. Add the following option to `gjp mvn` during your build:
 
     -DskipTests=true -Djava.io.tmpdir=<full path to project>/kit/tmp
@@ -81,6 +76,8 @@ Use the following option in `mvn` in your build.sh file to make it reproducible:
 
     -DskipTests=true -Djava.io.tmpdir=$PROJECT_PREFIX/kit/tmp
 
+* Tycho builds may also require NSS, so if you get NSS errors be sure to add `mozilla-nss` or an equivalent package in a BuildRequires: line;
+
 * if you want to be 100% sure your package builds without network access, you can use scripts in the `utils/` folder to create a special `nonet` user that cannot use the Internet and retry the build from that user.
 
 ## Frequently used sources

data/integration-tests/commons.sh

@@ -2,6 +2,8 @@
 
 # A crude integration test that builds commons-collections
 
+set -e
+
 rm -Rf galaxy
 mkdir galaxy
 cd galaxy

data/lib/gjp.rb

@@ -1,3 +1,4 @@
+# backend
 require "gjp/version"
 require "gjp/logger"
 require "gjp/template_manager"
@@ -18,4 +19,24 @@ require "gjp/spec_generator"
 require "gjp/archiver"
 require "gjp/kit_checker"
 
-require "gjp/cli"
+# UI
+require "gjp/commands/base"
+
+require "gjp/commands/ant"
+require "gjp/commands/download-maven-source-jars"
+require "gjp/commands/dry-run"
+require "gjp/commands/finish"
+require "gjp/commands/generate-all"
+require "gjp/commands/generate-kit-archive"
+require "gjp/commands/generate-kit-spec"
+require "gjp/commands/generate-package-archive"
+require "gjp/commands/generate-package-script"
+require "gjp/commands/generate-package-spec"
+require "gjp/commands/get-pom"
+require "gjp/commands/get-source"
+require "gjp/commands/init"
+require "gjp/commands/list-kit-missing-sources"
+require "gjp/commands/move-jars-to-kit"
+require "gjp/commands/mvn"
+
+require "gjp/main"

data/lib/gjp/ant_runner.rb

@@ -7,7 +7,7 @@ module Gjp
 
     # runs ant in a subprocess
     def ant(options)
-      run_executable("#{get_ant_commandline(@project.full_path)} #{options.join(' ')}")
+      run_executable("#{get_ant_commandline(@project.full_path)} #{options.join(" ")}")
     end
 
     # returns a command line for running Ant from the specified

data/lib/gjp/archiver.rb

@@ -13,17 +13,17 @@ module Gjp
     def archive_kit(full)
       destination_dir = File.join(@project.full_path, "output", "#{@project.name}-kit")
       FileUtils.mkdir_p(destination_dir)
-      destination_file_prefix = "#{@project.name}-kit"
-      destination_file_suffix = ".tar.xz"
+      file_prefix = "#{@project.name}-kit"
+      file_suffix = ".tar.xz"
 
       @project.take_snapshot "Kit archival started"
 
       destination_file = if full
-        remove_stale_incremental(destination_dir, destination_file_prefix, destination_file_suffix)
-        archive_single("kit", File.join(destination_dir, destination_file_prefix + destination_file_suffix))
+        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, destination_file_prefix, destination_file_suffix, :archive_kit)
+        archive_incremental("kit", destination_dir, file_prefix, file_suffix, :archive_kit)
       end
 
       @project.take_snapshot "Kit archive generated", :archive_kit
@@ -52,15 +52,15 @@ module Gjp
 
     # 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 destination_file_prefix_NNNN_destination_file_suffix
-    def archive_incremental(source_directory, destination_dir, destination_file_prefix, destination_file_suffix, tag_prefix)
+    # 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, destination_file_prefix + destination_file_suffix))
+          archive_single(source_directory, File.join(destination_dir, file_prefix + file_suffix))
         else
-          destination_file = File.join(destination_dir, "#{destination_file_prefix}_#{"%04d" % (latest_tag_count)}#{destination_file_suffix}")
+          destination_file = File.join(destination_dir, "#{file_prefix}_#{"%04d" % (latest_tag_count)}#{file_suffix}")
           tag = @project.latest_tag(tag_prefix)
           log.debug "creating #{destination_file} with files newer than #{tag}"
 
@@ -80,9 +80,9 @@ module Gjp
     end
 
     # removes any stale incremental files
-    def remove_stale_incremental(destination_dir, destination_file_prefix, destination_file_suffix)
+    def remove_stale_incremental(destination_dir, file_prefix, file_suffix)
       Dir.entries(destination_dir)
-        .select { |f| f =~ /^#{destination_file_prefix}_([0-9]+)#{destination_file_suffix}$/}
+        .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))

data/lib/gjp/commands/ant.rb

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

data/lib/gjp/commands/base.rb

@@ -0,0 +1,94 @@
+# encoding: UTF-8
+require "clamp"
+require "gjp/logger"
+
+module Gjp
+  
+  # implements common options and utility methods
+  class BaseCommand < Clamp::Command
+    include Logger
+
+    # Options available to all gjp commands
+    option ["-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.is_dry_running == state
+        yield
+      else
+        if state == true
+          puts "Please start a dry-run first, use \"gjp dry-run\""
+        else
+          puts "Please finish or abort this dry-run first, use \"gjp finish\" or \"gjp 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"
+      if conflict_count > 0
+        puts "Warning: #{conflict_count} unresolved conflicts"
+      end
+    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
+      begin
+        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 gjp project directory, see gjp init"
+      rescue NoPackageDirectoryError => e
+        $stderr.puts "#{e.directory} is not a gjp package directory, see README"
+      rescue GitAlreadyInitedError => e
+        $stderr.puts "This directory is already a gjp project"
+      rescue ExecutableNotFoundError => e
+        $stderr.puts "Executable #{e.executable} not found in kit/ or any of its subdirectories"
+      end
+    end
+  end
+end