gjp 0.27.0 → 0.28.0

data/README.md

@@ -6,7 +6,7 @@ The project objective is to strongly reduce manual packaging efforts by enabling
 
 ## Status
 
-`gjp` is a research project currently in alpha state. Basic concepts seem to be viable, packages are currently being built with the new approach to identify problem areas but not all basic features have been coded yet. If you are a packager you can try to use it (any feedback would be **very** welcome!), but be warned that anything can still change at this point.
+`gjp` is a research project currently in beta state. All basic features have been coded, non-essential ones are being planned, packages are currently being built. If you are a packager you can try to use it, any feedback would be **very** welcome!
 
 At the moment `gjp` is tested on openSUSE and can only output RPMs for the openSUSE and SLES distributions. Fedora, RHEL and other distros could be supported in the future.
 
@@ -50,7 +50,7 @@ Note that:
 * a `gjp` project can be used to build a number of packages that share one binary kit. This can help if the kit becomes big in size;
 * `gjp` will take advantage of Maven's pom files to generate its specs if they are available. This allows to precompile most spec fields automatically.
 
-### Sample project (commons-collections)
+### A sample Maven project (commons-collections)
 
 #### Initialization and project setup
 
@@ -146,7 +146,24 @@ OBS users: note that the output/ directory created by gjp can be submitted or us
     gjp finish
     gjp generate-all
 
-#### Ant packages
+#### Kit sources
+
+If you want to redistribute your RPMs, chances are that you need source files for kit contents.
+
+If you use Maven, most sources for binary jars in your kit can be automatically downloaded:
+
+    gjp get-maven-source-jars
+
+For non-Maven jars, or Maven jars that have no available sources, some extra manual work is needed. At the moment `gjp` can help you with the following utility subcommands:
+
+* `gjp get-pom NAME` will attempt to find a pom. `NAME` can be a jar file on your disk, a project directory, or simply a `name-version` string. `gjp` will get the pom either from the package itself or through search.maven.org using heuristic searching;
+* `gjp get-parent-pom POM` will attempt to download a pom's parent from search.maven.org, where `POM` is a filename or URI;
+* `gjp get-source-address POM` will attempt to find the SCM Internet address of a pom.xml from the file itself or through api.github.com. `POM` can either be a filename or a URI;
+* `gjp get-source POM ADDRESS` downloads the source of a pom.xml's project from its SCM at ADDRESS;
+
+More comprehensive support is planned in future releases.
+
+#### Optional: Ant packages
 
 Building Ant packages is not really different from Maven ones, as `gjp ant` will operate exactly like `gjp mvn`.
 
@@ -170,30 +187,15 @@ Once built, you are advised to grab an "informational" pom.xml (via `gjp get-pom
 
 The above is not mandatory, but it can be useful for debugging purposes.
 
-#### Optional: kit sources
 
-If kit sources are needed for license compliance, some extra work is needed. Fortunately, finding jar source files and adding them to the kit is much easier than packaging its contents in proper RPMs!
-
-If the project you are packaging uses Maven, you can ask Maven itself to find source jars for dependencies. Running the following command will add them to the kit:
-
-    gjp mvn dependency:sources
-
-Unfortunately this will not take care of Maven itself, Maven's plugins and their dependencies so some extra work might be needed.
-
-At the moment `gjp`'s supprort to kit source retrieval is limited to the following subcommands:
-
-* `gjp get-pom NAME` will attempt to find a pom. `NAME` can be a jar file on your disk, a project directory, or simply a `name-version` string. `gjp` will get the pom either from the package itself or through search.maven.org using heuristic searching;
-* `gjp get-parent-pom POM` will attempt to download a pom's parent from search.maven.org, where `POM` is a filename or URI;
-* `gjp get-source-address POM` will attempt to find the SCM Internet address of a pom.xml from the file itself or through api.github.com. `POM` can either be a filename or a URI;
-* `gjp get-source POM ADDRESS` downloads the source of a pom.xml's project from its SCM at ADDRESS;
-
-More comprehensive support is planned in future releases.
+### Gotchas
 
-You are advised to use [Maven Central](http://search.maven.org/) to search for sources and other information about projects.
+* `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:
 
-### Troubleshooting
+    export NO_BRP_CHECK_BYTECODE_VERSION=true
 
-`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 freely 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).
 
 ## Motivation
 

data/lib/gjp/cli.rb

@@ -216,11 +216,38 @@ module Gjp
 
     subcommand "purge-jars", "Locates jars in src/ and moves them to kit/" do
       def execute
-        project = Gjp::Project.new(".")
+        checking_exceptions do
+          project = Gjp::Project.new(".")
+
+          ensure_dry_running(false, project) do
+            project.purge_jars.each do |original, final|
+              puts "Replaced #{original} with symlink pointing to to #{final}"
+            end
+          end
+        end
+      end
+    end
 
-        ensure_dry_running(false, project) do
-          project.purge_jars.each do |original, final|
-            puts "Replaced #{original} with symlink pointing to to #{final}"
+    subcommand "get-maven-source-jars", "Attempts to download Maven kit/ sources" do
+      def execute
+        checking_exceptions do
+          project = Gjp::Project.new(".")
+          source_getter = Gjp::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
@@ -337,7 +364,7 @@ module Gjp
       rescue Errno::EEXIST => e
         $stderr.puts e
       rescue NoProjectDirectoryError => e
-        $stderr.puts "#{e.directory} not a gjp project directory, see gjp init"
+        $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

data/lib/gjp/kit_runner.rb

@@ -31,6 +31,7 @@ module Gjp
     def run_executable(full_commandline)
       log.debug "running #{full_commandline}"
       Process.wait(Process.spawn(full_commandline))
+      $?
     end
 
     # runs mvn in a subprocess

data/lib/gjp/source_getter.rb

@@ -3,10 +3,29 @@
 require "rest_client"
 
 module Gjp
-  # attempts to get java projects' sources from scm
+  # attempts to get java projects' sources
   class SourceGetter
     include Logger
 
+    # looks for jars in maven's local repo and downloads corresponding
+    # source jars
+    def get_maven_source_jars(project)
+      kit_runner = Gjp::KitRunner.new(project)
+
+      project.from_directory do
+        paths = Find.find(".").reject {|path| artifact_from_path(path) == nil}.sort
+
+        succeded_paths = paths.select.with_index do |path, i|
+          artifact = artifact_from_path(path)
+          log.info("attempting source download for #{path} (#{artifact})")
+          status = kit_runner.mvn(["dependency:get", "-Dartifact=#{artifact}", "-Dtransitive=false"])
+          status.exitstatus == 0
+        end
+
+        [succeded_paths, (paths - succeded_paths)]
+      end
+    end
+
     # downloads a project's source into a specified directory
     def get_source(address, pomfile, directory)
       log.info("downloading: #{address} in #{directory}, pomfile: #{pomfile}")
@@ -81,5 +100,15 @@ module Gjp
   		best_version = version_matcher.best_match(version, versions_to_tags.keys)
   		versions_to_tags[best_version]
   	end
+
+    private
+
+    # if possible, turn path into a Maven artifact name, otherwise return nil
+    def artifact_from_path(path)
+      match = path.match(/\.\/kit\/m2\/(.+)\/(.+)\/(.+)\/\2-\3.*\.jar$/)
+      if match != nil
+        "#{match[1].gsub("/", ".")}:#{match[2]}:#{match[3]}:jar:sources"
+      end
+    end
   end
 end

data/lib/gjp/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module Gjp
-  VERSION = "0.27.0"
+  VERSION = "0.28.0"
 end

data/spec/lib/kit_runner_spec.rb

@@ -19,8 +19,8 @@ describe Gjp::KitRunner do
 
   describe "#find_executable"  do
     it "finds an executable in kit" do
-      mock_executable("mvn")
-      @kit_runner.find_executable("mvn").should eq @executable
+      executable_path = mock_executable("mvn", @project_path)
+      @kit_runner.find_executable("mvn").should eq executable_path
     end
     it "doesn't find a Maven executable in kit" do
       @kit_runner.find_executable("mvn").should be_nil
@@ -29,11 +29,11 @@ describe Gjp::KitRunner do
 
   describe "#get_maven_commandline"  do
     it "returns commandline options for running maven" do
-      mock_executable("mvn")
+      executable_path = mock_executable("mvn", @project_path)
 
       @project.from_directory do
         commandline = @kit_runner.get_maven_commandline(".")
-        commandline.should eq "./#{@executable} -Dmaven.repo.local=./kit/m2 -s./kit/m2/settings.xml"
+        commandline.should eq "./#{executable_path} -Dmaven.repo.local=./kit/m2 -s./kit/m2/settings.xml"
       end
     end
     it "doesn't return commandline options if Maven is not available" do
@@ -43,7 +43,7 @@ describe Gjp::KitRunner do
 
   describe "#mvn"  do
     it "runs maven" do
-      mock_executable("mvn")
+      mock_executable("mvn", @project_path)
       @project.from_directory do
         @kit_runner.mvn(["extra-option"])
         File.read("test_out").strip.should match /extra-option$/
@@ -59,11 +59,11 @@ describe Gjp::KitRunner do
 
   describe "#get_ant_commandline"  do
     it "returns commandline options for running Ant" do
-      mock_executable("ant")
+      executable_path = mock_executable("ant", @project_path)
 
       @project.from_directory do
         commandline = @kit_runner.get_ant_commandline(".")
-        commandline.should eq "./#{@executable}"
+        commandline.should eq "./#{executable_path}"
       end
     end
     it "doesn't return commandline options if Ant is not available" do
@@ -73,7 +73,7 @@ describe Gjp::KitRunner do
 
   describe "#ant"  do
     it "runs Ant" do
-      mock_executable("ant")
+      mock_executable("ant", @project_path)
       @project.from_directory do
         @kit_runner.ant(["extra-option"])
         File.read("test_out").strip.should match /extra-option$/
@@ -85,14 +85,4 @@ describe Gjp::KitRunner do
       end
     end
   end
-
-  def mock_executable(executable)
-    Dir.chdir(@project_path) do
-      @bin_dir = File.join("kit", executable, "bin")
-      FileUtils.mkdir_p(@bin_dir)
-      @executable = File.join(@bin_dir, executable)
-      File.open(@executable, "w") { |io| io.puts "echo $0 $*>test_out" }
-      File.chmod(0777, @executable)
-    end
-  end
 end

data/spec/lib/source_getter_spec.rb

@@ -6,6 +6,37 @@ require "fileutils"
 describe Gjp::SourceGetter do
   let(:source_getter) { Gjp::SourceGetter.new }
 
+  describe "#get_maven_source_jars" do
+    before(:each) do
+      @project_path = File.join("spec", "data", "test-project")
+      Dir.mkdir(@project_path)
+
+      Gjp::Project.init(@project_path)
+      @project = Gjp::Project.new(@project_path)
+    end
+
+    it "gets sources for jars in the Maven repo through Maven itself" do
+      mock_executable("mvn", @project_path)
+
+      @project.from_directory(File.join("kit", "m2")) do
+        jar_dir_path = File.join("net", "test", "artifact", "1.0")
+        jar_path = File.join(jar_dir_path, "artifact-1.0-blabla.jar")
+        FileUtils.mkdir_p(jar_dir_path)
+        FileUtils.touch(jar_path)
+
+        successes, failures = source_getter.get_maven_source_jars(@project)
+        commandline = File.read(File.join("..", "..", "test_out")).strip
+        commandline.should match /-Dartifact=net.test:artifact:1.0:jar:sources -Dtransitive=false$/
+        successes.should include File.join(".", "kit", "m2", jar_path)
+        failures.should eq []
+      end
+    end
+
+    after(:each) do
+      FileUtils.rm_rf(@project_path)
+    end
+  end
+
   describe "#get_source_from_git" do
     it "gets the sources from a git repo" do
       dir_path = File.join("spec", "data", "nailgun")

data/spec/spec_helper.rb

@@ -4,3 +4,17 @@ require "gjp"
 require "gjp/logger"
 
 Gjp::Logger.log.level = ::Logger::DEBUG
+
+# creates an executable in kit that will print its parameters
+# in a test_out file for checking. Returns mocked executable
+# full path
+def mock_executable(executable_name, project_path)
+  Dir.chdir(project_path) do
+    bin_dir = File.join("kit", executable_name, "bin")
+    FileUtils.mkdir_p(bin_dir)
+    executable_path = File.join(bin_dir, executable_name)
+    File.open(executable_path, "w") { |io| io.puts "echo $0 $*>test_out" }
+    File.chmod(0777, executable_path)
+    executable_path
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gjp
 version: !ruby/object:Gem::Version
-  version: 0.27.0
+  version: 0.28.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-28 00:00:00.000000000 Z
+date: 2013-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake