rascal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 814d874743694d11422907bf02213100735789bb30c4f6a04d5bf57d3a686541
+  data.tar.gz: 77a43969306a5d45e84a8f7a4e3518604b09989701afc4829188ae6385ef464d
+SHA512:
+  metadata.gz: f076c894c0bebe868de8f56764ce47d2bd54ed8052550aa4595c48238515db324f5582f0f0f612976b81e06f99597bd76d303f8b2171ada400b221280c7ca4ae
+  data.tar.gz: e2ac5cf785f08ab3f1adfafde4c2bd8e6e0a2bb72ebb740b279d584379341915f4e595c5b987a1b8ecb00236cc7f50321e449074c83223cb62a3618ce6d88c7a

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.5

data/.travis.yml

@@ -0,0 +1,16 @@
+# yes, we use travis for open source gems
+
+language: ruby
+rvm:
+  - '2.5.4'
+gemfile:
+  - Gemfile
+script: bundle exec rake
+sudo: false
+cache: vendor/bundler
+notifications:
+  email:
+    - fail@makandra.de
+install:
+  - gem install bundler:2.0.1
+  - bundle install --no-deployment --jobs=3 --retry=3 --path=${BUNDLE_PATH:-vendor/bundle}

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Rascal Changelog
+
+All notable changes to this project will be documented here.
+
+Rascal follows semantic versioning. This has little consequence pre 1.0, so expect breaking changes.
+
+
+## 0.1.0 (2019-03-21)
+
+initial release

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rascal.gemspec
+gemspec
+
+gem 'rake', '~> 10.0'
+gem 'rspec'
+gem 'cucumber'
+gem 'aruba'
+
+gem 'guard-rspec'
+gem 'guard-cucumber'

data/Gemfile.lock

@@ -0,0 +1,110 @@
+PATH
+  remote: .
+  specs:
+    rascal (0.1.0)
+      thor (~> 0.20.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.14.9)
+      childprocess (>= 0.6.3, < 1.1.0)
+      contracts (~> 0.9)
+      cucumber (>= 1.3.19)
+      ffi (~> 1.9)
+      rspec-expectations (>= 2.99)
+      thor (~> 0.19)
+    backports (3.12.0)
+    builder (3.2.3)
+    childprocess (1.0.1)
+      rake (< 13.0)
+    coderay (1.1.2)
+    contracts (0.16.0)
+    cucumber (3.1.2)
+      builder (>= 2.1.2)
+      cucumber-core (~> 3.2.0)
+      cucumber-expressions (~> 6.0.1)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (~> 1.3)
+      gherkin (~> 5.1.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (3.2.1)
+      backports (>= 3.8.0)
+      cucumber-tag_expressions (~> 1.1.0)
+      gherkin (~> 5.0)
+    cucumber-expressions (6.0.1)
+    cucumber-tag_expressions (1.1.1)
+    cucumber-wire (0.0.1)
+    diff-lcs (1.3)
+    ffi (1.10.0)
+    formatador (0.2.5)
+    gherkin (5.1.0)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-cucumber (1.5.4)
+      cucumber (>= 1.3.0)
+      guard-compat (~> 1.0)
+      nenv (~> 0.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    multi_json (1.13.1)
+    multi_test (0.1.2)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    thor (0.20.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  cucumber
+  guard-cucumber
+  guard-rspec
+  rake (~> 10.0)
+  rascal!
+  rspec
+
+BUNDLED WITH
+   2.0.1

data/Guardfile

@@ -0,0 +1,25 @@
+guard :rspec, cmd: 'bundle exec rspec', notification: false, failed_mode: :focus do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard 'cucumber', all_on_start: false, all_after_pass: false, notification: false do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { "features" }
+
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "features"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tobias Kraze
+
+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,78 @@
+# Rascal [![Build Status](https://travis-ci.org/makandra/rascal.svg?branch=master)](https://travis-ci.org/makandra/rascal)
+
+### Use CI environments locally. Not quite a vagrant.
+
+We use Gitlab-CI to run CI for our projects, using Docker containers.
+
+In certain situations, it can be helpful to set up an environment identical to a CI
+node on your local machine. `rascal` allows you to do just that by parsing your CI config
+(currently only `.gitlab-ci.yml`), starting required services and bringing up a Docker
+container.
+
+## Installation
+
+Install with
+
+    $ gem install rascal
+
+
+## Caveats
+
+*This is an early alpha version. Use at your own risk.*
+
+Only the parsing of `.gitlab-ci.yml` is currently supported, and only a subset of the possible syntax
+will be properly interpreted.
+
+
+## Usage
+
+You need to add some extra information to your `.gitlab-ci.yml`. A working version might look like this:
+
+```
+# settings here override job settings
+.rascal:
+  repo_dir: /repo
+  variables:
+    BUNDLE_PATH: /cache/bundle
+  volumes:
+    cache: /cache
+  before_shell:
+    - bundle check
+
+.environment: &environment
+  image: registry.makandra.de/makandra/ci-images/test-env:2.5
+  services:
+    - name: registry.makandra.de/makandra/ci-images/pg:9.5
+      alias: pg-db
+    - name: registry.makandra.de/makandra/ci-images/redis:4
+      alias: redis
+  before_script:
+    - ruby -v
+    - bundle install
+    - bundle exec rake db:create db:schema:load
+  variables:
+    BUNDLE_PATH: ./bundle/vendor
+    DATABASE_URL: postgresql://pg_user@pg-db/test-db
+    DATABASE_CLEANER_ALLOW_REMOTE_DATABASE_URL: "true"
+    REDIS_URL: redis://redis
+    PROMPT: CI env
+  cache:
+    paths:
+      - ./bundle/vendor
+
+
+# ============= Actual jobs ================
+
+rspec:
+  <<: *environment
+  script:
+    - bundle exec rake knapsack:rspec
+  parallel: 4
+```
+
+Then, in your project root, run `rascal shell rspec`.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+RSpec::Core::RakeTask.new(:spec)
+Cucumber::Rake::Task.new(:features)
+
+desc 'Run specs and features'
+task :test => [:spec, :features]
+
+task default: :test

data/bin/_guard-core

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application '_guard-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "_guard-core")

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rascal"
+
+# 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/cucumber

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'cucumber' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("cucumber", "cucumber")

data/bin/guard

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "guard")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

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/exe/rascal

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rascal/io_helper'
+require 'rascal/cli'
+require 'rascal/version'
+
+if ARGV == ['-v'] || ARGV == ['--version']
+  puts "Rascal version #{Rascal::VERSION}."
+else
+  Rascal::CLI::Main.start
+end

data/lib/rascal/cli/base.rb

@@ -0,0 +1,39 @@
+require 'pathname'
+
+module Rascal
+  module CLI
+    class Base
+      def initialize(thor, options)
+        @thor = thor
+        @options = options
+      end
+
+      private
+
+      def config_location
+        Pathname.new(@options[:config_file]).expand_path
+      end
+
+      def fail_with_error(message)
+        raise Thor::Error, message
+      end
+
+      def find_environment(environment_name)
+        if (definition = EnvironmentsDefinition.detect(config_location))
+          if (environment = definition.environment(environment_name))
+            return environment
+          else
+            available_environments = definition.available_environment_names.join(', ')
+            if environment_name
+              fail_with_error("Unknown environment #{environment_name}. Available: #{available_environments}.")
+            else
+              fail_with_error("Missing environment. Available: #{available_environments}.")
+            end
+          end
+        else
+          fail_with_error("Could not find an environment definition in current working directory.")
+        end
+      end
+    end
+  end
+end

data/lib/rascal/cli/clean.rb

@@ -0,0 +1,16 @@
+require 'rascal'
+
+module Rascal
+  module CLI
+    class Clean < Base
+      def initialize(thor, options, environment_name)
+        @environment_name = environment_name
+        super(thor, options)
+      end
+
+      def run
+        find_environment(@environment_name)&.clean
+      end
+    end
+  end
+end

data/lib/rascal/cli/main.rb

@@ -0,0 +1,45 @@
+module Rascal
+  module CLI
+    class Main < Thor
+      def help(subcommand = false)
+        if subcommand
+          super
+        else
+          say
+          say 'Usage:'
+          say '  rascal <command> <args>'
+          say 'For example:'
+          say '  rascal shell 2.6'
+          say
+          super
+          say 'For Further information about the commands, you can use "rascal help <command>".'
+          say
+        end
+      end
+
+      def self.exit_on_failure?
+        # return non-zero exit code for failures
+        true
+      end
+
+      def self.start(*)
+        IOHelper.setup
+        super
+      end
+
+
+      map "shell" => "_shell"
+      desc 'shell ENVIRONMENT', 'Start a docker shell for the given environment'
+      def _shell(environment_name = nil)
+        Shell.new(self, options, environment_name).run
+      end
+
+      desc 'clean ENVIRONMENT', 'Stop and remove docker containers for the given environment'
+      def clean(environment_name = nil)
+        Clean.new(self, options, environment_name).run
+      end
+
+      class_option :config_file, aliases: ['-c'], default: '.', required: true, banner: 'path to configuration file or directory containing it'
+    end
+  end
+end

data/lib/rascal/cli/shell.rb

@@ -0,0 +1,16 @@
+require 'rascal'
+
+module Rascal
+  module CLI
+    class Shell < Base
+      def initialize(thor, options, environment_name)
+        @environment_name = environment_name
+        super(thor, options)
+      end
+
+      def run
+        find_environment(@environment_name)&.run_shell
+      end
+    end
+  end
+end

data/lib/rascal/cli.rb

@@ -0,0 +1,10 @@
+require 'thor'
+
+module Rascal
+  module CLI
+    autoload :Base,  'rascal/cli/base'
+    autoload :Clean, 'rascal/cli/clean'
+    autoload :Main,  'rascal/cli/main'
+    autoload :Shell, 'rascal/cli/shell'
+  end
+end