autoproj-jenkins 0.1.0

data/lib/autoproj/jenkins/updater.rb

@@ -0,0 +1,214 @@
+module Autoproj::Jenkins
+    # Returns true if the given VCS type is supported
+    #
+    # @param [#to_s] vcs the VCS type (e.g. 'git')
+    def self.vcs_supported?(vcs)
+        Autoproj::Jenkins.has_template?("import-#{vcs}.pipeline")
+    end
+
+    # Update a jenkins server configuration from an autoproj workspace
+    class Updater
+        # The autoproj workspace
+        #
+        # @return [Autoproj::Workspace]
+        attr_reader :ws
+
+        # The server we have to update
+        #
+        # @return [Server]
+        attr_reader :server
+
+        # A string that is prefixed to all job names
+        #
+        # @return [String]
+        attr_reader :job_prefix
+
+        # Create a new updater context for an autoproj workspace and Jenkins
+        # server
+        #
+        # @param [Autoproj::Workspace] ws
+        # @param [Server] server
+        # @param [String] job_prefix a string that should be prefixed to all job
+        #   names
+        def initialize(ws, server, job_prefix: '')
+            @ws = ws
+            @server = server
+            @job_prefix = job_prefix
+        end
+
+        # Create the master buildconf job
+        #
+        # @return [void]
+        def create_buildconf_job(force: false, quiet_period: 5)
+            if force
+                server.delete_job("#{job_prefix}buildconf")
+            end
+            server.create_job("#{job_prefix}buildconf", 'buildconf.xml', quiet_period: quiet_period)
+        end
+
+        # Update the buildconf pipeline
+        #
+        # @param [String] jenkins_url the URL of the jenkins server from the
+        #   point of view of the job's execution
+        # @param [String] gemfile the gemfile template that should be used for
+        #   the autoproj bootstrap. Mostly used for autoproj-jenkins development
+        #   within VMs
+        # @param [String] autoproj_install_path a path local to the jenkins
+        #   workspace where the autoproj_install script will be. If unset,
+        #   downloads it from github.com
+        # @param [Boolean] dev whether the packages pipelines should be updated
+        #   with --dev or not
+        # @param [Array<Autoproj::PackageDefinition>] packages if non-empty,
+        #   restrict operations to these packages and their dependencies
+        def update_buildconf_pipeline(*package_names, gemfile: 'buildconf-Gemfile', autoproj_install_path: nil, dev: false, credentials_id: nil, vcs_credentials: Credentials.new)
+            manifest_vcs = ws.manifest.vcs
+            if manifest_vcs.local? || manifest_vcs.none?
+                raise ArgumentError, "cannot use Jenkins to build an autoproj buildconf that is not on a remotely acessible VCS"
+            end
+
+            server.update_job_pipeline("#{job_prefix}buildconf", 'buildconf.pipeline',
+                vcs: manifest_vcs,
+                package_names: package_names,
+                gemfile: gemfile,
+                autoproj_install_path: autoproj_install_path,
+                job_prefix: job_prefix,
+                credentials_id: credentials_id,
+                vcs_credentials: vcs_credentials,
+                dev: dev)
+        end
+
+        # Create or update the buildconf (master) job
+        #
+        # @param [Array<Autoproj::PackageDefinition>] packages if non-empty,
+        #   restrict operations to these packages and their dependencies
+        # @param [String] gemfile the gemfile template that should be used for
+        #   the autoproj bootstrap. Mostly used for autoproj-jenkins development
+        #   within VMs
+        # @param [Integer] quiet_period the job's quiet period, in seconds.
+        #   Mostly used within autoproj-jenkins tests
+        def create_or_update_buildconf_job(*packages, gemfile: 'buildconf-Gemfile', autoproj_install_path: nil, dev: false, quiet_period: 5, credentials_id: nil, vcs_credentials: Credentials.new)
+            job_name = "#{job_prefix}buildconf"
+            if !server.has_job?(job_name)
+                create_buildconf_job(quiet_period: quiet_period)
+            end
+            update_buildconf_pipeline(
+                *packages,
+                gemfile: gemfile,
+                autoproj_install_path: autoproj_install_path,
+                credentials_id: credentials_id,
+                vcs_credentials: vcs_credentials,
+                dev: dev)
+        end
+
+        # Returns the job name of a given package
+        #
+        # @param [String] package_name
+        # @return [String]
+        def job_name_from_package_name(package_name)
+            "#{job_prefix}#{package_name.gsub('/', '-')}"
+        end
+
+        # Create a job for a package
+        #
+        # @return [void]
+        def create_package_job(package, job_name: job_name_from_package_name(package.name), force: false, quiet_period: 5)
+            job_name = job_name_from_package_name(package.name)
+            if force
+                server.delete_job(job_name)
+            end
+
+            server.create_job(job_name, 'package.xml', quiet_period: quiet_period)
+        end
+
+        # Resolve a package by its name
+        def package_by_name(package_name)
+            package = ws.manifest.find_package_definition(package_name)
+            if !package
+                raise ArgumentError, "no package called #{package_name}"
+            end
+        end
+
+        def compute_upstream_packages(package)
+            upstream_packages = package.autobuild.dependencies.inject(Set.new) do |all, pkg_name|
+                all << pkg_name
+                ws.manifest.find_autobuild_package(pkg_name).all_dependencies(all)
+            end
+            upstream_packages.delete(package.name)
+            upstream_packages
+        end
+
+        def compute_downstream_packages(package, reverse_dependencies)
+            queue   = [package.name]
+            results = Set.new
+            while !queue.empty?
+                p_name = queue.shift
+                if !results.include?(p_name)
+                    results << p_name
+                    queue.concat(reverse_dependencies[p_name].to_a)
+                end
+            end
+            results.delete(package.name)
+            results
+        end
+
+        def compute_job_to_package_map(package_names, included_package_names)
+            result = Hash.new
+            package_names.each do |pkg_name|
+                if included_package_names.include?(pkg_name)
+                    job_name = job_name_from_package_name(pkg_name)
+                    result[job_name] = pkg_name
+                end
+            end
+            result
+        end
+
+        # Create jobs and dependencies to handle the given set of packages
+        #
+        # @return [Array<String>] the list of names of the jobs that have been
+        #   created/updated
+        def update(*packages, quiet_period: 5, gemfile: 'buildconf-Gemfile', autoproj_install_path: nil, vcs_credentials: Credentials.new)
+            reverse_dependencies = ws.manifest.compute_revdeps
+
+            packages.each do |package|
+                job_name = job_name_from_package_name(package.name)
+                if !server.has_job?(job_name)
+                    create_package_job(package, job_name: job_name, quiet_period: quiet_period)
+                end
+            end
+
+            package_names = packages.map(&:name).to_set
+            packages.map do |package|
+                job_name = job_name_from_package_name(package.name)
+                if !Autoproj::Jenkins.vcs_supported?(package.vcs.type)
+                    raise UnhandledVCS, "the #{package.vcs.type} importer, used by #{package.name}, is not supported by autoproj-jenkins"
+                end
+
+                upstream_jobs = compute_job_to_package_map(compute_upstream_packages(package), package_names)
+                downstream_jobs = compute_job_to_package_map(compute_downstream_packages(package, reverse_dependencies), package_names)
+
+                prefix_relative_path =
+                    if package.autobuild.srcdir == package.autobuild.prefix
+                        Pathname.new(package.autobuild.srcdir).
+                            relative_path_from(Pathname.new(ws.root_dir)).to_s
+                    else
+                        "install/#{package.name}"
+                    end
+
+                server.update_job_pipeline(job_name, 'package.pipeline',
+                    buildconf_vcs: ws.manifest.vcs,
+                    vcs: package.vcs,
+                    package_name: package.name,
+                    package_dir: Pathname.new(package.autobuild.srcdir).relative_path_from(Pathname.new(ws.root_dir)).to_s,
+                    artifact_glob: "**/*",
+                    job_name: job_name,
+                    upstream_jobs: upstream_jobs,
+                    downstream_jobs: downstream_jobs,
+                    gemfile: gemfile,
+                    autoproj_install_path: autoproj_install_path,
+                    vcs_credentials: vcs_credentials)
+
+                job_name
+            end
+        end
+    end
+end

data/lib/autoproj/jenkins/version.rb

@@ -0,0 +1,5 @@
+module Autoproj
+    module Jenkins
+        VERSION = "0.1.0"
+    end
+end

data/lib/autoproj/jenkins.rb

@@ -0,0 +1,19 @@
+require 'find'
+require 'pathname'
+require 'set'
+require 'jenkins_api_client'
+require "autoproj"
+require "autoproj/autobuild"
+require "autoproj/jenkins/version"
+require "autoproj/jenkins/exceptions"
+require "autoproj/jenkins/render_template"
+require "autoproj/jenkins/server"
+require "autoproj/jenkins/updater"
+require "autoproj/jenkins/relativize"
+require "autoproj/jenkins/credentials"
+
+module Autoproj
+  module Jenkins
+    # Your code goes here...
+  end
+end

data/lib/autoproj-jenkins.rb

@@ -0,0 +1,8 @@
+require 'autoproj/cli/main_jenkins'
+
+class Autoproj::CLI::Main
+    desc 'jenkins', 'jenkins-specific functionality'
+    subcommand 'jenkins', Autoproj::CLI::MainJenkins
+end
+
+

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: autoproj-jenkins
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sylvain Joyeux
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jenkins_api_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: autoproj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0.rc20
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0.rc20
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: flexmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- sylvain.joyeux@m4x.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- autoproj-jenkins.gemspec
+- lib/autoproj-jenkins.rb
+- lib/autoproj/cli/jenkins.rb
+- lib/autoproj/cli/main_jenkins.rb
+- lib/autoproj/cli/test_postprocessing.rb
+- lib/autoproj/jenkins.rb
+- lib/autoproj/jenkins/credentials.rb
+- lib/autoproj/jenkins/exceptions.rb
+- lib/autoproj/jenkins/relativize.rb
+- lib/autoproj/jenkins/render_template.rb
+- lib/autoproj/jenkins/server.rb
+- lib/autoproj/jenkins/templates/abort-if-upstream-failed.pipeline.erb
+- lib/autoproj/jenkins/templates/bootstrap.pipeline.erb
+- lib/autoproj/jenkins/templates/buildconf-Gemfile
+- lib/autoproj/jenkins/templates/buildconf-config.yml.erb
+- lib/autoproj/jenkins/templates/buildconf-vagrant-Gemfile
+- lib/autoproj/jenkins/templates/buildconf.pipeline.erb
+- lib/autoproj/jenkins/templates/buildconf.xml.erb
+- lib/autoproj/jenkins/templates/handle-downstream.pipeline.erb
+- lib/autoproj/jenkins/templates/import-archive.pipeline.erb
+- lib/autoproj/jenkins/templates/import-git.pipeline.erb
+- lib/autoproj/jenkins/templates/import-svn.pipeline.erb
+- lib/autoproj/jenkins/templates/jenkins_dependency_overrides.rb.erb
+- lib/autoproj/jenkins/templates/package-Gemfile
+- lib/autoproj/jenkins/templates/package.pipeline.erb
+- lib/autoproj/jenkins/templates/package.xml.erb
+- lib/autoproj/jenkins/templates/setup-git-credentials.pipeline.erb
+- lib/autoproj/jenkins/templates/wait-upstream.pipeline.erb
+- lib/autoproj/jenkins/test_format_converters/boost-test.xsl
+- lib/autoproj/jenkins/updater.rb
+- lib/autoproj/jenkins/version.rb
+homepage: https://github.com/doudou/autoproj-jenkins
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Exporting an autoproj build to a jenkins server
+test_files: []
+has_rdoc: