bee_java 0.0.1

data/lib/dependency_resolver.rb

@@ -0,0 +1,482 @@
+# Copyright 2008-2009 Michel Casabianca <michel.casabianca@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'net/http'
+require 'fileutils'
+require 'rexml/document'
+require 'rexml/xpath'
+require 'bee_util'
+
+module Bee
+  
+  module Task
+
+    # Parent of all dependency resolvers.
+    class BaseDependencyResolver
+
+      include Bee::Util::BuildErrorMixin
+
+      # Default repository.
+      DEFAULT_REPOSITORY = nil
+      # Default cache location.
+      DEFAULT_CACHE      = nil
+      # Default dependency scope.
+      DEFAULT_SCOPE      = 'compile'
+
+      # Constructor:
+      # - file: dependency file (should be maven.xml).
+      # - scope: the scope for dependencies (compile, runtime or test).
+      # - verbose: tells if we should be verbose.
+      def initialize(file, scope, verbose=false)
+        @file = file
+        @scope = scope
+        @verbose = verbose
+        @repositories = parse_repositories
+        @cache = DEFAULT_CACHE
+        @dependencies = nil
+        # print information if verbose
+        puts "Repositories: #{@repositories.join(', ')}" if @verbose
+      end
+
+      # Return the classpath.
+      def classpath
+        synchronize
+        classpath = @dependencies.map do |dependency| 
+          build_path(@cache, dependency)
+        end
+        return classpath.join(File::PATH_SEPARATOR)
+      end
+
+      # Return dependencies as a list.
+      def dependencies
+        synchronize
+        dependencies = @dependencies.map do |dependency| 
+          build_path(@cache, dependency)
+        end
+        return dependencies
+      end
+
+      private
+
+      # Resolve dependencies.
+      # Returns dependencies as a list.
+      def resolve
+        @dependencies = parse_dependencies(File.read(@file)) if
+          not @dependencies
+        return @dependencies
+      end
+
+      # Synchronize dependencies with local cache.
+      def synchronize
+        resolve
+        for dependency in @dependencies
+          tofile = build_path(@cache, dependency)
+          if not File.exists?(tofile)
+            save_file(download(dependency), tofile)
+          else
+            puts "Dependency '#{build_name(dependency)}' already downloaded" if
+              @verbose
+          end
+        end
+      end
+
+      # Extract repository list from file.
+      # Return: repository list.
+      def parse_repositories
+        raise 'Not implemented'
+      end
+
+      # Download a given dependency.
+      # - dependency: dependency as a map.
+      # Return: dependency as a binary.
+      def download(dependency, log=true)
+        name = build_name(dependency)
+        puts "Downloading dependency '#{name}'..." if log or @verbose
+        for repository in @repositories
+          url = build_path(repository, dependency)
+          puts "Trying '#{url}'..." if @verbose
+          begin
+            return fetch(url)
+          rescue
+          end
+        end
+        error "Dependency '#{name}' not found"
+      end
+
+      # Build a Maven path.
+      # - root: the path root (root directory for repository or cache).
+      # - dependency: dependency as a map.
+      # Return: path as a string.
+      def build_path(root, dependency)
+        raise 'Not implemented'
+      end
+
+      # Build dependency name for display.
+      # - dependency: dependency as a map.
+      # Return: name as a string.      
+      def build_name(dependency)
+        groupid = dependency[:groupid]
+        artifactid = dependency[:artifactid]
+        version = dependency[:version]
+        type = dependency[:type] || 'jar'
+        return "#{artifactid}:#{groupid}:#{version}:#{type}"
+      end
+
+      # Extract dependencies from a file.
+      # - source: file source.
+      # Return: dependencies as a list of maps with keys groupid, artifactid,
+      # version, type, optional.
+      def parse_dependencies(source)
+        raise 'Not implemented'
+      end
+
+      # Tells if a given dependency should be selected.
+      # - dependency: the dependency to consider.
+      def selected?(dependency)
+        return false if dependency[:optional] == 'true'
+        dep_scope = dependency[:scope] || DEFAULT_SCOPE
+        if @scope == 'compile'
+          if dep_scope == 'compile'
+            return true
+          else
+            return false
+          end
+        elsif @scope == 'runtime'
+          if dep_scope == 'compile' or dep_scope == 'runtime'
+            return true
+          else
+            return false
+          end
+        elsif @scope == 'test'
+          if dep_scope == 'compile' or dep_scope == 'runtime' or dep_scope == 'test'
+            return true
+          else
+            return false
+          end
+        end
+      end
+
+      # Save a given binary in a file and create directories as necessary.
+      # - binary: data to save.
+      # - tofile: file to save into.
+      def save_file(binary, tofile)
+        puts "Saving file '#{tofile}'..." if @verbose
+        directory = File.dirname(tofile)
+        FileUtils.makedirs(directory) if not File.exists?(directory)
+        File.open(tofile, 'wb') { |file| file.write(binary) }    
+      end
+
+      # Maximum number of HTTP redirections.
+      HTTP_REDIRECTIONS_LIMIT = 10
+  
+      # Get a given URL.
+      # - url: URL to get.
+      # - limit: redirectrion limit (defaults to HTTP_REDIRECTIONS_LIMIT).
+      def fetch(url, limit = HTTP_REDIRECTIONS_LIMIT)
+        puts "Fetching '#{url}'..." if @verbose
+        raise 'HTTP redirect too deep' if limit == 0
+        response = Net::HTTP.get_response(URI.parse(url))
+        case response
+        when Net::HTTPSuccess
+          response.body
+        when Net::HTTPRedirection
+          fetch(response['location'], limit - 1)
+        else
+          response.error!
+        end
+      end
+
+    end
+  
+    # Bee dependency resolver.
+    class BeeDependencyResolver < BaseDependencyResolver
+
+      # Default repository address.
+      DEFAULT_REPOSITORY = 'http://repo1.maven.org/maven2'
+      # Default cache location.
+      DEFAULT_CACHE      = File.expand_path('~/.java/dependencies')
+
+      # Constructor:
+      # - file: dependency file (should be maven.xml).
+      # - scope: the scope for dependencies (compile, runtime or test).
+      # - verbose: tells if we should be verbose.
+      def initialize(file, scope, verbose=false)
+        super(file, scope, verbose)
+        @cache = DEFAULT_CACHE
+      end
+
+      # Extract dependencies from a file.
+      # - source: file source.
+      # Return: dependencies as a list of maps with keys groupid, artifactid,
+      # version, type, optional.
+      def parse_dependencies(source)
+        dependencies = YAML::load(source)
+        new_dependencies = []
+        for dependency in dependencies
+          if dependency['group']
+            new_dependency = {}
+            for key in dependency.keys
+              if key != 'group' and key != 'artifact'
+                new_dependency[key.to_sym] = dependency[key]
+              elsif key == 'group'
+                new_dependency[:groupid] = dependency['group']
+              elsif key == 'artifact'
+                new_dependency[:artifactid] = dependency['artifact']
+              end
+            end
+            new_dependencies << new_dependency
+          end
+        end
+        return new_dependencies
+      end
+
+      # Extract repository list from file.
+      # Return: repository list.
+      def parse_repositories
+        repositories = YAML::load(File.read(@file))
+        new_repositories = []
+        for repository in repositories
+          if repository['repository']
+            new_repositories << repository['repository']
+          elsif repository['repositories']
+            new_repositories = new_repositories + repository['repositories']
+          end
+        end
+        return new_repositories
+      end
+
+      # Build a Maven path.
+      # - root: the path root (root directory for repository or cache).
+      # - dependency: dependency as a map.
+      # Return: path as a string.
+      def build_path(root, dependency)
+        groupid = dependency[:groupid].split('.').join('/')
+        artifactid = dependency[:artifactid]
+        version = dependency[:version]
+        type = dependency[:type] || 'jar'
+        classifier = dependency[:classifier]
+        if classifier
+          return "#{root}/#{groupid}/#{artifactid}/#{version}/#{artifactid}-#{version}-#{classifier}.#{type}"
+        else
+          return "#{root}/#{groupid}/#{artifactid}/#{version}/#{artifactid}-#{version}.#{type}"
+        end        
+      end
+
+    end
+
+    # Maven 1 dependency resolver.
+    class MavenDependencyResolver < BaseDependencyResolver
+
+      include Bee::Util::BuildErrorMixin
+
+      # Default repository.
+      DEFAULT_REPOSITORY = 'http://repo1.maven.org/maven'
+      # Default cache location.
+      DEFAULT_CACHE      = File.expand_path('~/.maven/repository')
+      # Default dependency scope.
+      DEFAULT_SCOPE      = 'compile'
+
+      # Constructor:
+      # - file: dependency file (should be maven.xml).
+      # - scope: the scope for dependencies (compile, runtime or test).
+      # - verbose: tells if we should be verbose.
+      def initialize(file, scope, verbose=false)
+        super(file, scope, verbose)
+        @cache = DEFAULT_CACHE
+      end
+
+      private
+
+      # Synchronize dependencies with local cache.
+      def synchronize
+        resolve
+        for dependency in @dependencies
+          tofile = build_path(@cache, dependency)
+          if not File.exists?(tofile)
+            save_file(download(dependency), tofile)
+          else
+            puts "Dependency '#{build_name(dependency)}' already downloaded" if
+              @verbose
+          end
+        end
+      end
+
+      # Extract repository list from file.
+      # Return: repository list.
+      def parse_repositories
+        repositories = []
+        doc = REXML::Document.new(File.read(@file))
+        REXML::XPath.each(doc, '/project/repository') do |element|
+          REXML::XPath.each(element, 'url') do |entry|
+            repositories << entry.text.strip
+          end
+        end
+        repositories << DEFAULT_REPOSITORY if repositories.empty?
+        return repositories
+      end
+
+      # Build a Maven path.
+      # - root: the path root (root directory for repository or cache).
+      # - dependency: dependency as a map.
+      # Return: path as a string.
+      def build_path(root, dependency)
+        groupid = dependency[:groupid]
+        artifactid = dependency[:artifactid]
+        version = dependency[:version]
+        type = dependency[:type] || 'jar'
+        return "#{root}/#{groupid}/#{type}s/#{artifactid}-#{version}.#{type}"
+      end
+
+      # Extract dependencies from a file.
+      # - source: file source.
+      # Return: dependencies as a list of maps with keys groupid, artifactid,
+      # version, type, optional.
+      def parse_dependencies(source)
+        dependencies = []
+        doc = REXML::Document.new(source)
+        properties = {}
+        REXML::XPath.each(doc, '/project/properties/*') do |element|
+          name = element.name.strip
+          value = element.text
+          value = value.strip if value
+          properties[name] = value
+        end
+        REXML::XPath.each(doc, '/project/dependencies/dependency') do |element|
+          dependency = {}
+          REXML::XPath.each(element, '*') do |entry|
+            name = entry.name.downcase.to_sym
+            value = entry.text.strip
+            for key in properties.keys
+              value = value.gsub(/\$\{#{key}\}/, properties[key]) if 
+                properties[key]
+            end
+            dependency[name] = value
+          end
+          dependencies << dependency if selected?(dependency)
+        end
+        return dependencies
+      end
+
+    end
+
+    # Maven 2 dependency resolver.
+    class Maven2DependencyResolver < MavenDependencyResolver
+
+      # Default repository address.
+      DEFAULT_REPOSITORY = 'http://repo1.maven.org/maven2'
+      # Default cache location.
+      DEFAULT_CACHE      = File.expand_path('~/.m2/repository')
+
+      # Constructor:
+      # - file: dependency file (should be maven.xml).
+      # - scope: the scope for dependencies (compile, runtime or test).
+      # - verbose: tells if we should be verbose.
+      def initialize(file, scope, verbose=false)
+        super(file, scope, verbose)
+        @cache = DEFAULT_CACHE
+      end
+
+      private
+
+      # Resolve dependencies.
+      # Returns dependencies as a list.
+      def resolve
+        if not @dependencies
+          @dependencies = parse_dependencies(File.read(@file))
+          for dependency in @dependencies
+            @dependencies = @dependencies + recurse_dependency(dependency)
+          end
+        end
+        return @dependencies
+      end
+
+      # Recurse on a given dependency.
+      # - dependency: depedency to recurse over as a map.
+      # Return: dependencies as a list.
+      def recurse_dependency(dependency)
+        pom = dependency.clone
+        pom[:type] = 'pom'
+        new_dependencies = []
+        begin
+          pom_file = build_path(@cache, pom)
+          if not File.exists?(pom_file)
+            new_pom = download(pom, false)
+            save_file(new_pom, pom_file)
+          else
+            name = build_name(pom)
+            puts "POM file '#{name}' already downloaded" if @verbose
+            new_pom = File.read(pom_file)
+          end
+          new_dependencies = parse_dependencies(new_pom)
+          for new_dependency in new_dependencies
+            to_add = recurse_dependency(new_dependency)
+            new_dependencies = new_dependencies + to_add if not to_add.empty
+          end
+        rescue
+        end
+        return new_dependencies
+      end
+
+      # Extract repository list from POM file or 
+      # Return: repository list.
+      def parse_repositories
+        repositories = []
+        # search for repositories in POM file
+        doc = REXML::Document.new(File.read(@file))
+        REXML::XPath.each(doc, '/project/distributionManagement/repository') do |element|
+          REXML::XPath.each(element, 'url') do |entry|
+            repositories << entry.text.strip
+          end
+        end
+        # search for repositories in cache repository
+        begin
+          doc = REXML::Document.new(File.read(File.expand_path('~/.m2/settings.xml')))
+          REXML::XPath.each(doc, '/settings/mirrors/mirror') do |element|
+            REXML::XPath.each(element, 'url') do |entry|
+              repositories << entry.text.strip
+            end
+          end
+          REXML::XPath.each(doc, '/settings/profiles/profile/repositories/repository') do |element|
+            REXML::XPath.each(element, 'url') do |entry|
+              repositories << entry.text.strip
+            end
+          end
+        rescue
+        end
+        repositories << DEFAULT_REPOSITORY if repositories.empty?
+        return repositories.uniq
+      end
+
+      # Build a Maven path.
+      # - root: the path root (root directory for repository or cache).
+      # - dependency: dependency as a map.
+      # Return: path as a string.
+      def build_path(root, dependency)
+        groupid = dependency[:groupid].split('.').join('/')
+        artifactid = dependency[:artifactid]
+        version = dependency[:version]
+        type = dependency[:type] || 'jar'
+        classifier = dependency[:classifier]
+        if classifier
+          return "#{root}/#{groupid}/#{artifactid}/#{version}/#{artifactid}-#{version}-#{classifier}.#{type}"
+        else
+          return "#{root}/#{groupid}/#{artifactid}/#{version}/#{artifactid}-#{version}.#{type}"
+        end        
+      end
+
+    end
+
+  end
+
+end

data/test/build.yml

@@ -0,0 +1,125 @@
+# Copyright 2008-2009 Michel Casabianca <michel.casabianca@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+- build: test_java
+  default: all
+  description: Build file to test Java package
+
+- properties:
+  - name:      "test"
+  - src:       "src"
+  - build:     "build"
+  - classes:   "#{build}/classes"
+  - javadoc:   "#{build}/api"
+  - jar:       "#{build}/#{name}.jar"
+  - erb:       "manifest.erb"
+  - manifest:  "#{build}/manifest"
+  - main:      "test.Test"
+  - classpath: :jar
+  - junit:     "/opt/java/junit-4.4"
+  - test:      "test"
+  - test_classes: "#{build}/test-classes"
+  - lib:       "#{build}/lib"
+
+- target: javac
+  description: Test javac task
+  script:
+  - java.javac:
+      src:  :src
+      dest: :classes
+
+- target: jar
+  depends: javac
+  description: Test jar task
+  script:
+  - erb:
+      src:  :erb
+      dest: :manifest
+  - java.jar:
+      src:      :classes
+      manifest: :manifest
+      dest:     :jar
+
+- target: junit
+  depends: javac
+  description: Run unit tests
+  script:
+  - find:
+      includes: "#{junit}/junit*.jar"
+      excludes: "#{junit}/junit*-src.jar"
+      property: junit_cp
+  - java.javac:
+      src: :test
+      dest: :test_classes
+      classpath: [:junit_cp, :classes]
+  - java.junit:
+      classpath: [:classes, :test_classes, :junit_cp]
+      src:       :test
+
+- target: javadoc
+  description: Document Java source files
+  script:
+  - java.javadoc:
+      src: :src
+      dest: :javadoc
+
+- target: java
+  depends: jar
+  description: Run java program
+  script:
+  - java.java:
+      main:       :main
+      classpath:  :classpath
+      properties: { who: World }
+  - java.java:
+      main:       :main
+      classpath:  :classes
+      properties: { who: World }
+  - java.java:
+      jar: :jar
+      properties: { who: World }
+
+- target: deps
+  description: Fetch dependencies
+  script:
+  # maven 1 repository
+  - rmdir: :build
+  - java.deps:
+      src:  dependencies.yml
+      dest: :lib
+      repos: http://www.ibiblio.org/maven
+  # maven 2 repository
+  - rmdir: :build
+  - java.deps:
+      src:  dependencies.xml
+      dest: :lib
+      repos: http://repo1.maven.org/maven2
+      repotype: maven2
+
+- target: classpath
+  description: Compute a classpath
+  script:
+  #- java.clean:
+  - java.classpath:
+      file:     pom.xml
+      property: classpath
+  - print: :classpath
+
+- target: clean
+  description: Clean generated files
+  script:
+  - rmdir: :build
+
+- target: all
+  depends: [clean, javac, jar, junit, javadoc, java, deps]

data/test/dependencies.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<project>
+  <dependencies>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.3</version>
+    </dependency>
+  </dependencies>
+</project>

data/test/dependencies.yml

@@ -0,0 +1,3 @@
+- group: junit
+  artifact: junit
+  version: 4.3

data/test/manifest.erb

@@ -0,0 +1 @@
+Main-Class: <%= main %>

data/test/pom.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<project>
+
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>test</groupId>
+  <artifactId>test</artifactId>
+  <name>Test</name>
+  <version>1.0.0</version>
+
+  <repositories>
+    <repository>
+      <id>central</id>
+      <name>Maven Repository Switchboard</name>
+      <layout>default</layout>
+      <url>http://repo1.maven.org/maven2</url>
+      <snapshots>
+        <enabled>false</enabled>
+      </snapshots>
+    </repository>
+  </repositories>
+
+  <dependencies>
+    <dependency>
+      <groupId>ehcache</groupId>
+      <artifactId>ehcache</artifactId>
+      <version>1.2beta4</version>
+    </dependency>
+  </dependencies>
+
+</project>

data/test/src/test/Test.java

@@ -0,0 +1,28 @@
+// Copyright 2008-2009 Michel Casabianca <michel.casabianca@gmail.com>
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package test;
+
+public class Test {
+
+    public static void main(String[] args) {
+        String who = System.getProperty("who");
+        System.out.println(hello(who));
+    }
+
+    public static String hello(String who) {
+        return "Hello "+who+"!";
+    }
+
+}