djin 0.8.0 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 558aca989aad2d1cfd7b19768a7a5d6fd2f660afb5135fb9ca3ae03eacb233b4
-  data.tar.gz: f2e5c3861c6db601b77bc04321386cb2c22ec049d315781966830ba8a5f6e8af
+  metadata.gz: c8ed8e839aa664296b03ffabbd80b1394d68bfbd02439205d79d26fc7b450653
+  data.tar.gz: a7023cca57674f3f7e176d80b21f7c60d3251017df6f1252bd47d3549ed89740
 SHA512:
-  metadata.gz: a898ea486006d81980a4e963a1e7b2d31f40c5bec00d9b5948f4b32d0be5c222b61525c90fd214523cd482aadeab88e3927cb3a3697f7fc86b8180901e015543
-  data.tar.gz: 3d6b0a29b1faa6a3bffb0fa5076ee88083229cbb36f77f2166e44bc19ddd84b73bd6b254578da2c721e1c08ffc7e9583f1325bdd73acc87511ceec47b3f0e512
+  metadata.gz: f8e9ead0edc8cf175b3fad08e6129f023be758610bc2e0636cd4d0b72aa7b2239b08b84234693127ddd8f1e74731852a5e7e2d0bdf8de55bbb17f88734aac625
+  data.tar.gz: 9d2f4d89f2a1a220b67f3e8a0d97b95e43c75f542559eb8ead1d829c4687f9a856f644268c3e3f3ed3a63f20d765d9689653490eb4a6d527fa1e4f864a18eb57

data/.github/workflows/ruby.yml

@@ -1,23 +1,37 @@
 name: Ruby
 
-on: [push]
+on: [push, workflow_dispatch]
 
 jobs:
   build:
     runs-on: ubuntu-16.04
     strategy:
       matrix:
-        ruby: [ '2.4', '2.5', '2.6' ]
+        ruby: [ '2.5', '2.6', '2.7' ]
     name: Ruby ${{ matrix.ruby }}
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - run: |
-          gem install bundler
-          bundle install --jobs 4 --retry 3
-          bundle exec rake
+
+      - name: Setup Code Climate test-reporter
+        run: |
+          curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+          chmod +x ./cc-test-reporter
+          ./cc-test-reporter before-build
+
+      - name: Build
+        run: |
+          docker-compose -p djin_ruby_${{ matrix.ruby }} build --build-arg ${{ matrix.ruby }} app
+
+      - name: Run tests
+        run: |
+          docker-compose -p djin_ruby_${{ matrix.ruby }} run --rm app rspec
+        env:
+          TMP_TEST_FILE_FOLDER: '/tmp'
+
+      - name: Publish code coverage
+        run: |
+          # TODO: Move to script
+          docker-compose -p djin_ruby_${{ matrix.ruby }} run --rm app 'export GIT_BRANCH="${GITHUB_REF/refs\/heads\//}" && ./cc-test-reporter after-build -r ${{secrets.CC_TEST_REPORTER_ID}}'
 
   lint:
     runs-on: ubuntu-16.04
@@ -27,8 +41,10 @@ jobs:
       - uses: actions/setup-ruby@v1
         with:
           ruby-version: '2.6'
-      - run: |
+      - name: Install Gems
+        run: |
           gem install bundler
           bundle install --jobs 4 --retry 3
-          bundle exec rubocop
+      - name: Rubocop
+        run: bundle exec rubocop
 

data/.gitignore

@@ -7,6 +7,7 @@
 /spec/reports/
 /tmp/
 .byebug_history
+.irb_history
 
 # rspec failure tracking
 .rspec_status

data/.irbrc

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+IRB.conf[:SAVE_HISTORY] = 200
+IRB.conf[:HISTORY_FILE] = '~/.irb_history'

data/.rubocop.yml

@@ -3,6 +3,11 @@ inherit_from: .rubocop_todo.yml
 Style/Documentation:
   Enabled: false
 
+Style/BlockDelimiters:
+  Exclude:
+    - spec/**/*
+
 Metrics/BlockLength:
   Exclude:
     - spec/**/*
+    - djin.gemspec 

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 0.11.2 - 29/01/2021
+ * [FIX] Remote-Config Fetch for custom Branches
+  [FIX] Integration Specs
+
+## 0.11.1 - 15/01/2021
+ * [FIX] remote-config fetch with same repo reference
+
+## 0.11.0 - 14/01/2021
+ * [FEATURE] Remote Configs
+ * [TECH] Adds Test Coverage
+
+## 0.10.0 - 08/10/2020
+ * [FEATURE] -f command option
+
+## 0.9.0 - 17/09/2020
+ * [FEATURE] Include Option
+
 ## 0.8.0 - 31/08/2020
  * [FEATURE] Adds aliases option
 

data/Dockerfile

@@ -1,4 +1,5 @@
-FROM ruby:2.6.5-alpine AS builder
+ARG RUBY_VERSION
+FROM ruby:${RUBY_VERSION:-2.6.5}-alpine AS builder
 
 ENV BUILD_PACKAGES build-base git
 
@@ -13,17 +14,23 @@ COPY djin.gemspec Gemfile Gemfile.lock ./
 
 COPY lib/djin/version.rb lib/djin/version.rb
 
-RUN gem install bundler -v 2.0.2
+RUN gem install bundler -v 2.1.4
 
 RUN bundle install
 
+FROM builder AS dev
+
+WORKDIR /usr/src/djin
+
+COPY . .
+
 FROM ruby:2.6.5-alpine
 
 WORKDIR /usr/src/djin
 
 COPY --from=builder /usr/local/bundle/ /usr/local/bundle
 
-RUN gem install bundler -v 2.0.2
+RUN gem install bundler -v 2.1.4
 
 ENV DEPENDENCIES git
 

data/Gemfile

@@ -2,5 +2,9 @@
 
 source 'https://rubygems.org'
 
+group :test do
+  gem 'factory_bot'
+end
+
 # Specify your gem's dependencies in djin.gemspec
 gemspec

data/Gemfile.lock

@@ -1,73 +1,86 @@
 PATH
   remote: .
   specs:
-    djin (0.8.0)
+    djin (0.11.2)
       dry-cli (~> 0.6.0)
       dry-equalizer (~> 0.3.0)
       dry-struct (~> 1.3.0)
       dry-validation (~> 1.5.1)
+      git (~> 1.8.1)
       mustache (~> 1.1.1)
       vseries (~> 0.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.1)
     byebug (11.1.1)
     concurrent-ruby (1.1.7)
     diff-lcs (1.3)
+    docile (1.3.2)
     dry-cli (0.6.0)
       concurrent-ruby (~> 1.0)
-    dry-configurable (0.11.6)
+    dry-configurable (0.12.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.4, >= 0.4.7)
-      dry-equalizer (~> 0.2)
+      dry-core (~> 0.5, >= 0.5.0)
     dry-container (0.7.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.9)
+    dry-core (0.5.0)
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.3.0)
     dry-inflector (0.2.0)
-    dry-initializer (3.0.3)
-    dry-logic (1.0.7)
+    dry-initializer (3.0.4)
+    dry-logic (1.1.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.2)
-      dry-equalizer (~> 0.2)
-    dry-schema (1.5.3)
+      dry-core (~> 0.5, >= 0.5)
+    dry-schema (1.6.0)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.8, >= 0.8.3)
-      dry-core (~> 0.4)
-      dry-equalizer (~> 0.2)
+      dry-core (~> 0.5, >= 0.5)
       dry-initializer (~> 3.0)
       dry-logic (~> 1.0)
-      dry-types (~> 1.4)
+      dry-types (~> 1.5)
     dry-struct (1.3.0)
       dry-core (~> 0.4, >= 0.4.4)
       dry-equalizer (~> 0.3)
       dry-types (~> 1.3)
       ice_nine (~> 0.11)
-    dry-types (1.4.0)
+    dry-types (1.5.0)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
-      dry-core (~> 0.4, >= 0.4.4)
-      dry-equalizer (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    dry-validation (1.5.4)
+    dry-validation (1.5.6)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.7, >= 0.7.1)
       dry-core (~> 0.4)
       dry-equalizer (~> 0.2)
       dry-initializer (~> 3.0)
-      dry-schema (~> 1.5)
+      dry-schema (~> 1.5, >= 1.5.2)
+    factory_bot (6.1.0)
+      activesupport (>= 5.0.0)
+    git (1.8.1)
+      rchardet (~> 1.8)
+    i18n (1.8.7)
+      concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
+    json (2.3.1)
+    minitest (5.14.3)
     mustache (1.1.1)
     parallel (1.19.2)
     parser (2.7.1.4)
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.1)
+    rchardet (1.8.0)
     regexp_parser (1.7.1)
     rexml (3.2.4)
     rspec (3.9.0)
@@ -95,8 +108,16 @@ GEM
     rubocop-ast (0.0.3)
       parser (>= 2.7.0.1)
     ruby-progressbar (1.10.1)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
     vseries (0.1.1)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -105,9 +126,11 @@ DEPENDENCIES
   bundler (~> 2.0)
   byebug
   djin!
+  factory_bot
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop
+  simplecov (~> 0.17.0)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -2,6 +2,7 @@
 
 ![](https://github.com/catks/djin/workflows/Ruby/badge.svg?branch=master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/824a2e78399813543212/maintainability)](https://codeclimate.com/github/catks/djin/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/824a2e78399813543212/test_coverage)](https://codeclimate.com/github/catks/djin/test_coverage)
 
 Djin is a make-like utility for docker containers
 
@@ -13,7 +14,7 @@ Djin is distributed as a Ruby Gem, to install simple run:
 
 ### With Rbenv
 
-If you use Rbenv you can install djin only once and create a alias in your .basrc, .zshrc, etc:
+If you use Rbenv you can install djin only once and create an alias in your .basrc, .zshrc, etc:
 
 #### ZSH
     $ RBENV_VERSION=$(rbenv global) gem install djin && echo "alias djin='RBENV_VERSION=$(rbenv global) djin'" >> ~/.zshrc
@@ -26,7 +27,7 @@ If you use Rbenv you can install djin only once and create a alias in your .basr
 To use djin first you need to create a djin.yml file:
 
 ```yaml
-djin_version: '0.8.0'
+djin_version: '0.11.2'
 
 tasks:
   # With a docker image
@@ -53,12 +54,12 @@ You can also set task dependencies with depends_on option:
 
 
 ```yaml
-djin_version: '0.8.0'
+djin_version: '0.11.2'
 
 _default_run_options: &default_run_options
   options: "--rm"
 
-tasks: 
+tasks:
   "db:create":
     docker-compose:
       service: app
@@ -82,7 +83,7 @@ tasks:
 Or mix local commands and docker/docker-compose commands:
 
 ```yaml
-djin_version: '0.8.0'
+djin_version: '0.11.2'
 
 _default_run_options: &default_run_options
   options: "--rm"
@@ -121,7 +122,7 @@ After that you can run `djin {{task_name}}`, like `djin script` or `djin test`
 You can also use environment variables using the '{{YOUR_ENV_HERE}}' syntax, like so:
 
 ```yaml
-djin_version: '0.8.0'
+djin_version: '0.11.2'
 
 _default_run_options: &default_run_options
   options: "--rm"
@@ -138,7 +139,7 @@ tasks:
 
 Or define some variables to use in multiple locations
 ```yaml
-djin_version: '0.8.0'
+djin_version: '0.11.2'
 
 _default_run_options: &default_run_options
   options: "--rm"
@@ -162,7 +163,7 @@ tasks:
 It's also possible to pass custom arguments to the command, which means is possible to make a djin task act like the command itself:
 
 ```yaml
-djin_version: '0.8.0'
+djin_version: '0.11.2'
 
 _default_run_options: &default_run_options
   options: "--rm"
@@ -179,19 +180,145 @@ tasks:
 
 ```
 
-With that you can pass custom args after `--`, eg: `djin rubocop -- --parallel`, which wil make djin runs `rubocop --parallel` inside the service `app`.
+With that, you can pass custom args after `--`, eg: `djin rubocop -- --parallel`, which will make djin runs `rubocop --parallel` inside the service `app`.
 
 Under the hood djin uses [Mustache](https://mustache.github.io/), so you can use other features like conditionals: `{{#IS_ENABLE}} Enabled {{/IS_ENABLE}}` (for args use the `args?`, eg: `{{#args?}} {{args}} --and-other-thing{{/args?}}`), to see more more options you can access this [Link](https://mustache.github.io/mustache.5.html)
 
+### Reusing tasks
+
+If you have multiple tasks with similar behavior and with small differences you can use the `include` keyword, so this:
+
+```yaml
+djin_version: '0.11.2'
+
+tasks:
+  "host1:ssh":
+    local:
+      run:
+        - ssh my_user@host1.com.br
+
+  "host1:restart":
+    local:
+      run:
+        - ssh -t my_user@host1.com.br restart
+
+  "host1:logs":
+    local:
+      run:
+        - ssh -t my_user@host1.com.br tail -f /var/log/my_log
+
+  "host2:ssh":
+    local:
+      run:
+        - ssh my_user@host2.com.br
+
+  "host2:restart":
+    local:
+      run:
+        - ssh -t my_user@host2.com.br restart
+
+  "host2:logs":
+    local:
+      run:
+        - ssh -t my_user@host2.com.br tail -f /var/log/my_file
+
+```
+
+can become this:
+
+```yaml
+# djin.yml
+djin_version: '0.11.2'
+
+include:
+  - file: '.djin/server_tasks.yml'
+    context:
+      variables:
+        namespace: host1
+        host: host1.com
+        ssh_user: my_user
+
+  - file: '.djin/server_tasks.yml'
+    context:
+      variables:
+        namespace: host2
+        host: host2.com
+        ssh_user: my_user
+
+```
+
+
+```yaml
+# .djin/server_tasks.yml
+djin_version: '0.11.2'
+
+tasks:
+  "{{namespace}}:ssh":
+    local:
+      run:
+        - ssh {{ssh_user}}@{{host}}
+
+  "{{namespace}}:restart":
+    local:
+      run:
+        - ssh -t {{ssh_user}}@{{host}} restart
+
+  "{{namespace}}:logs":
+    local:
+      run:
+        - ssh -t {{ssh_user}}@{{host}} tail -f /var/log/my_log
+```
+
+You can also reuse tasks in some git repository, to do that you need to declare a git source and optionally a version:
+
+```yaml
+djin_version: '0.11.2'
+
+include:
+  - git: 'https://github.com/catks/djin.git'
+    version: 'master'
+    file: 'examples/djin_lib/test.yml'
+    context:
+      variables:
+        namespace: 'remote:'
+
+```
+
+After that run `djin remote-config fetch` to fetch the repo and you can start using the tasks (All remote repos are cloned in `~/.djin/remote`)
+
+See `djin remote-config` to learn more.
+
+### Loading custom files
+
+You can also specify a file to be read by djin with `-f`, eg:
+
+```bash
+djin -f my_file.yml # Returns the help for all tasks in my_file
+djin -f my_file.yml build # Execute the build task defined in my_file.yml
+```
+
+You can also specify multiple files to join tasks between files:
+
+```bash
+# Mix the tasks
+djin -f my_file.yml -f my_file2.yml # Returns the help for all tasks in my_file
+djin -f my_file.yml -f my_file2.yml build # Execute the build task defined in my_file.yml or my_file2.yml
+```
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, run `djin release -- {{increment_option}}` (where {{incremment_option}} can be `--patch`, `--minor` or `major`), which will change version, update the CHANGELOG.md, create a new commit, create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## TODO:
 
-1. Adds a `-f` option to load custom djin files
+## TODO
+
+1. Enable multiple -f options to merge configuration between files
+2. Option to export tasks to Makefile
+3. djin-export docker image to create and sync makefiles
+4. include a key option to add tasks in git repositories files (maybe with a local cache)
 
 ## Contributing