autoproj-ci 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 807429c3a708c91b9d1f061bd3138d6ce7f6bfa63b60cb56505b8c817dc0ea9a
+  data.tar.gz: 0cc4aa3955d61d2b30d5aad85a49c888b4312dd12c9685ca17e8f5fc261d8fde
+SHA512:
+  metadata.gz: dfd1ed123ab40e60b71f41925940dbb947b16d91abb5e6c8e68f66ef18283ebb97e9953c4a4f1151776d0cfe09f25d807ee884dbfcc314cee56852e5f9ccfdb2
+  data.tar.gz: 3824b52d7b226df53b6304d2a751357081052e50478fcd8cab4d844a5384b4d1b6b79b98fd61060f96557b8286b9eb16626836094c86768c37552b901af6f608

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  rubocop-rock: defaults.yml
+

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.17.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sylvain.joyeux@13robotics.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+gem 'autoproj', git: 'https://github.com/rock-core/autoproj'
+group :vscode do
+    gem 'pry'
+    gem 'pry-byebug'
+    gem 'rubocop', '>= 0.6.0'
+    gem 'ruby-debug-ide', '>= 0.6.0'
+    gem 'debase', '>= 0.2.2.beta10'
+    gem 'solargraph'
+end
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in autoproj-ci.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Sylvain Joyeux
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# Autoproj::CI
+
+
+## Installation
+
+Run
+
+~~~
+autoproj plugin install autoproj-ci
+~~~
+
+From within an autoproj workspace
+
+## Usage
+
+### Build cache
+
+The `autoproj ci cache-push`, `autoproj ci build` and `autoproj ci
+cache-pull` subcommands allow you to save build artifacts (push) or get them
+from the cache (pull and build) to avoid re-building things that are not
+needed. The pull may be used to unarchive the relevant artifacts from the
+archive dir into the workspace's prefix. `build` does `cache-pull` and
+triggers a build that will ignore the cached packages. `cache-push` updates
+the cache using the packages successfully build by the last build command.
+
+`cache-pull` generates a JSON file that can be used to determine what has been
+pulled from the cache. Cached packages can then be provided to the `--not` option
+of `autoproj build`, as e.g.
+
+~~~
+autoproj build --not this_package that_package
+~~~
+
+Passing the options must be done by your build environment. It's not automatically
+handled by the tools
+
+## Development
+
+Install the plugin with a `--path` option to use your working checkout
+
+~~~
+autoproj plugin install autoproj-ci --path /path/to/checkout
+~~~
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/rock-core/autoproj-ci. This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](http://contributor-covenant.org) code of
+conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Autoproj::Ci project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/[USERNAME]/autoproj-ci/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/autoproj-ci.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "autoproj/ci/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "autoproj-ci"
+  spec.version       = Autoproj::CI::VERSION
+  spec.authors       = ["Sylvain Joyeux"]
+  spec.email         = ["sylvain.joyeux@13robotics.com"]
+
+  spec.homepage      = "https://github.com/rock-core/autoproj-ci"
+  spec.summary       = %q{plugin that provide subcommand useful in CI environments}
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/rock-core/autoproj-ci"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'autoproj'
+  spec.add_development_dependency "flexmock"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "autoproj/ci"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/autoproj-ci.rb

@@ -0,0 +1,6 @@
+require 'autoproj/cli/main_ci'
+
+class Autoproj::CLI::Main
+    desc 'ci', 'subcommands tuned for usage in CI environments'
+    subcommand 'ci', Autoproj::CLI::MainCI
+end

data/lib/autoproj/ci/version.rb

@@ -0,0 +1,7 @@
+module Autoproj
+    # autoproj-ci is an Autoproj plugin to provide functionality useful for CI
+    # (automated builds & tests)
+    module CI
+        VERSION = "0.2.0"
+    end
+end

data/lib/autoproj/cli/ci.rb

@@ -0,0 +1,179 @@
+require 'autoproj/cli/inspection_tool'
+require 'tmpdir'
+
+module Autoproj
+    module CLI
+        # Actual implementation of the functionality for the `autoproj ci` subcommand
+        #
+        # Autoproj internally splits the CLI definition (Thor subclass) and the
+        # underlying functionality of each CLI subcommand. `autoproj-ci` follows the
+        # same pattern, and registers its subcommand in {MainCI} while implementing
+        # the functionality in this class
+        class CI < InspectionTool
+            def resolve_packages
+                initialize_and_load
+                source_packages, * = finalize_setup(
+                    [], non_imported_packages: :ignore)
+                source_packages.map do |pkg_name|
+                    ws.manifest.find_autobuild_package(pkg_name)
+                end
+            end
+
+            def cache_pull(dir, silent: true)
+                packages = resolve_packages
+
+                memo   = Hash.new
+                results = packages.each_with_object({}) do |pkg, h|
+                    state, fingerprint = pull_package_from_cache(dir, pkg, memo: memo)
+                    puts "pulled #{pkg.name} (#{fingerprint})" if state && !silent
+
+                    h[pkg.name] = {
+                        'cached' => state,
+                        'fingerprint' => fingerprint
+                    }
+                end
+
+                unless silent
+                    hit = results.count { |_, info| info['cached'] }
+                    puts "#{hit} hits, #{results.size - hit} misses"
+                end
+
+                results
+            end
+
+            def cache_push(dir, silent: true)
+                packages = resolve_packages
+
+                built = load_built_flags
+
+                memo   = Hash.new
+                results = packages.each_with_object({}) do |pkg, h|
+                    unless built[pkg.name]
+                        next
+                    end
+
+                    state, fingerprint = push_package_to_cache(dir, pkg, memo: memo)
+                    puts "pushed #{pkg.name} (#{fingerprint})" if state && !silent
+
+
+                    h[pkg.name] = {
+                        'updated' => state,
+                        'fingerprint' => fingerprint
+                    }
+                end
+
+                unless silent
+                    hit = results.count { |_, info| info['updated'] }
+                    puts "#{hit} updated packages, #{results.size - hit} reused entries"
+                end
+
+                results
+            end
+
+            # Build a report in a given directory
+            #
+            # The method itself will not archive the directory, only gather the
+            # information in a consistent way
+            def build_report(dir)
+                initialize_and_load
+                finalize_setup([], non_imported_packages: :ignore)
+
+                report = consolidated_report
+                FileUtils.mkdir_p dir
+                File.open(File.join(dir, 'report.json'), 'w') do |io|
+                    JSON.dump(report, io)
+                end
+
+                installation_manifest = InstallationManifest.
+                    from_workspace_root(@ws.root_dir)
+                logs = File.join(dir, 'logs')
+                # Pre-create the logs, or cp_r will have a different behavior
+                # if the directory exists or not
+                FileUtils.mkdir_p logs
+                installation_manifest.each_package do |pkg|
+                    glob = Dir.glob(File.join(pkg.logdir, '*'))
+                    FileUtils.cp_r(glob, logs) if File.directory?(pkg.logdir)
+                end
+            end
+
+            def package_cache_path(dir, pkg, fingerprint: nil, memo: {})
+                fingerprint ||= pkg.fingerprint(memo: memo)
+                File.join(dir, pkg.name, fingerprint)
+            end
+
+            def pull_package_from_cache(dir, pkg, memo: {})
+                fingerprint = pkg.fingerprint(memo: memo)
+                path = package_cache_path(dir, pkg, fingerprint: fingerprint, memo: memo)
+                unless File.file?(path)
+                    return [false, fingerprint]
+                end
+
+                FileUtils.mkdir_p pkg.prefix
+                result = system("tar", "xzf", path, chdir: pkg.prefix, out: '/dev/null')
+                unless result
+                    raise "tar failed when pulling cache file for #{pkg.name}"
+                end
+                [true, pkg.fingerprint(memo: memo)]
+            end
+
+            def push_package_to_cache(dir, pkg, memo: {})
+                fingerprint = pkg.fingerprint(memo: memo)
+                path = package_cache_path(dir, pkg, fingerprint: fingerprint, memo: memo)
+                if File.file?(path)
+                    return [false, fingerprint]
+                end
+
+                temppath = "#{path}.#{Process.pid}.#{rand(256)}"
+                FileUtils.mkdir_p File.dirname(path)
+                result = system("tar", "czf", temppath, ".",
+                    chdir: pkg.prefix, out: '/dev/null')
+                unless result
+                    raise "tar failed when pushing cache file for #{pkg.name}"
+                end
+
+                FileUtils.mv temppath, path
+                [true, fingerprint]
+            end
+
+            def load_built_flags
+                path = @ws.build_report_path
+                return {} unless File.file?(path)
+
+                report = JSON.load(File.read(path))
+                report['build_report']['packages'].
+                    each_with_object({}) do |pkg_report, h|
+                        h[pkg_report['name']] = pkg_report['built']
+                    end
+            end
+
+            def consolidated_report
+                cache_pull = File.join(@ws.root_dir, 'cache-pull.json')
+                cache_report = if File.file?(cache_pull)
+                    JSON.load(File.read(cache_pull))
+                else
+                    {}
+                end
+
+                packages =
+                    if File.file?(@ws.build_report_path)
+                        path = @ws.build_report_path
+                        report = JSON.load(File.read(path))
+                        report['build_report']['packages']
+                    elsif File.file?(@ws.import_report_path)
+                        path = @ws.import_report_path
+                        report = JSON.load(File.read(path))
+                        report['import_report']['packages']
+                    end
+                return unless packages
+
+                packages = packages.each_with_object({}) do |pkg_info, h|
+                    name = pkg_info.delete('name')
+                    h[name] = cache_report[name] || { 'cached' => false }
+                    h[name].merge!(pkg_info)
+                end
+                { 'packages' => packages }
+            end
+        end
+    end
+end
+

data/lib/autoproj/cli/main_ci.rb

@@ -0,0 +1,95 @@
+require 'autoproj'
+
+module Autoproj
+    module CLI
+        # CLI interface for autoproj-ci
+        class MainCI < Thor
+            desc 'build [ARGS]', "Just like autoproj build, but can use a build cache"
+            option :cache, type: 'string',
+                desc: 'path to the build cache'
+            option :report, type: 'string', default: 'cache-pull.json',
+                desc: 'a file which describes what has been pulled'
+            def build(*args)
+                if (cache = options.delete(:cache))
+                    cache = File.expand_path(cache)
+                    results = cache_pull(cache)
+                    pulled_packages = results.
+                        map { |name, pkg| name if pkg['cached'] }.
+                        compact
+                    not_args = ['--not', *pulled_packages] unless pulled_packages.empty?
+                end
+
+                Process.exec(Gem.ruby, $PROGRAM_NAME, 'build', "--interactive=f", *args, *not_args)
+            end
+
+            desc 'cache-pull CACHE_DIR',
+                "This command gets relevant artifacts from a build cache and "\
+                "populates the current workspace's prefix with them. It is meant "\
+                "to be executed after a full checkout of the workspace"
+            option :report, type: 'string', default: 'cache-pull.json',
+                desc: 'a file which describes what has been done'
+            def cache_pull(dir)
+                dir = File.expand_path(dir)
+
+                require 'autoproj/cli/ci'
+                results = nil
+                Autoproj.report(silent: true) do
+                    cli = CI.new
+                    args, options = cli.validate_options(dir, self.options)
+                    report = options.delete(:report)
+
+                    results = cli.cache_pull(*dir, silent: false, **options)
+
+                    if report && !report.empty?
+                        File.open(report, 'w') do |io|
+                            JSON.dump(results, io)
+                        end
+                    end
+                end
+                results
+            end
+
+            desc 'cache-push CACHE_DIR',
+                "This command writes the packages successfully built in the last "\
+                "build to the given build cache, so that they can be reused with "\
+                "cache-pull"
+            option :report, type: 'string', default: 'cache-push.json',
+                desc: 'a file which describes what has been done'
+            def cache_push(dir)
+                dir = File.expand_path(dir)
+
+                require 'autoproj/cli/ci'
+                Autoproj.report(silent: true) do
+                    cli = CI.new
+
+                    args, options = cli.validate_options(dir, self.options)
+                    report = options.delete(:report)
+
+                    results = cli.cache_push(*dir, silent: false, **options)
+
+                    if report && !report.empty?
+                        File.open(report, 'w') do |io|
+                            JSON.dump(results, io)
+                        end
+                    end
+                end
+            end
+
+            desc "build-report PATH",
+                "Create a tarball containing all the information about this "\
+                "build, such as cache information (from cache-pull), Autoproj\'s "\
+                "build report and installation manifest, and the package\'s logfiles"
+            def build_report(path)
+                path = File.expand_path(path)
+
+                require 'autoproj/cli/ci'
+                Autoproj.report(silent: true) do
+                    cli = CI.new
+                    args, options = cli.validate_options(path, self.options)
+                    cli.build_report(*args, **options)
+                end
+            end
+        end
+    end
+end
+

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: autoproj-ci
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Sylvain Joyeux
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: autoproj
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: 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'
+description: 
+email:
+- sylvain.joyeux@13robotics.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- autoproj-ci.gemspec
+- bin/console
+- bin/setup
+- lib/autoproj-ci.rb
+- lib/autoproj/ci/version.rb
+- lib/autoproj/cli/ci.rb
+- lib/autoproj/cli/main_ci.rb
+homepage: https://github.com/rock-core/autoproj-ci
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rock-core/autoproj-ci
+  source_code_uri: https://github.com/rock-core/autoproj-ci
+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.7.6.2
+signing_key: 
+specification_version: 4
+summary: plugin that provide subcommand useful in CI environments
+test_files: []