djin 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 558aca989aad2d1cfd7b19768a7a5d6fd2f660afb5135fb9ca3ae03eacb233b4
-  data.tar.gz: f2e5c3861c6db601b77bc04321386cb2c22ec049d315781966830ba8a5f6e8af
+  metadata.gz: e763f1dad923699c768e998f4dd5caa53ac7a8b0ad4d7acd84c708effdcb627c
+  data.tar.gz: 9ab841b39557b775ec7832a3c1cd0befaf983e89ba931459b89a52d5a5df0bda
 SHA512:
-  metadata.gz: a898ea486006d81980a4e963a1e7b2d31f40c5bec00d9b5948f4b32d0be5c222b61525c90fd214523cd482aadeab88e3927cb3a3697f7fc86b8180901e015543
-  data.tar.gz: 3d6b0a29b1faa6a3bffb0fa5076ee88083229cbb36f77f2166e44bc19ddd84b73bd6b254578da2c721e1c08ffc7e9583f1325bdd73acc87511ceec47b3f0e512
+  metadata.gz: e22bc8b7d3deb635180db1d5c49f1e7d5df1eef3f1b4184b13d65b24eaa45b6f716edfae1bb4799abfe4d4255387958f5f078d931c72cf0b5e407abf9d85ee51
+  data.tar.gz: e603ff5f1bab170ed9758331e7c64e39f1832424fc2c0e069aeef2ce85372081ccc15e1a2080cae3c5edc4c8d8fd1286643e4aaa02616249f7173c6d660ffcf2

data/.github/workflows/ruby.yml

@@ -14,10 +14,12 @@ jobs:
       - uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      - run: |
+      - name: Install Gems
+        run: |
           gem install bundler
           bundle install --jobs 4 --retry 3
-          bundle exec rake
+      - name: Run tests
+        run: bundle exec rake
 
   lint:
     runs-on: ubuntu-16.04
@@ -27,8 +29,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/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.9.0 - 17/09/2020
+ * [FEATURE] Include Option
+
 ## 0.8.0 - 31/08/2020
  * [FEATURE] Adds aliases option
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    djin (0.8.0)
+    djin (0.9.0)
       dry-cli (~> 0.6.0)
       dry-equalizer (~> 0.3.0)
       dry-struct (~> 1.3.0)
@@ -34,7 +34,7 @@ GEM
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.2)
       dry-equalizer (~> 0.2)
-    dry-schema (1.5.3)
+    dry-schema (1.5.4)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.8, >= 0.8.3)
       dry-core (~> 0.4)
@@ -54,13 +54,13 @@ GEM
       dry-equalizer (~> 0.3)
       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)
     ice_nine (0.11.2)
     mustache (1.1.1)
     parallel (1.19.2)

data/README.md

@@ -26,7 +26,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.9.0'
 
 tasks:
   # With a docker image
@@ -53,7 +53,7 @@ You can also set task dependencies with depends_on option:
 
 
 ```yaml
-djin_version: '0.8.0'
+djin_version: '0.9.0'
 
 _default_run_options: &default_run_options
   options: "--rm"
@@ -82,7 +82,7 @@ tasks:
 Or mix local commands and docker/docker-compose commands:
 
 ```yaml
-djin_version: '0.8.0'
+djin_version: '0.9.0'
 
 _default_run_options: &default_run_options
   options: "--rm"
@@ -121,7 +121,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.9.0'
 
 _default_run_options: &default_run_options
   options: "--rm"
@@ -138,7 +138,7 @@ tasks:
 
 Or define some variables to use in multiple locations
 ```yaml
-djin_version: '0.8.0'
+djin_version: '0.9.0'
 
 _default_run_options: &default_run_options
   options: "--rm"
@@ -162,7 +162,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.9.0'
 
 _default_run_options: &default_run_options
   options: "--rm"
@@ -183,6 +183,91 @@ With that you can pass custom args after `--`, eg: `djin rubocop -- --parallel`,
 
 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 behaviour and with small differences you can use the `include` keyword, so this:
+
+```yaml
+djin_version: '0.9.0'
+
+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.9.0'
+
+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.9.0'
+
+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
+  ```
+
 ## 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.

data/djin.yml

@@ -1,4 +1,4 @@
-djin_version: '0.8.0'
+djin_version: '0.9.0'
 
 _default_run_options: &default_run_options
   options: "--rm --entrypoint=''"

data/examples/djin.yml

@@ -1,5 +1,17 @@
 ---
-djin_version: '0.8.0'
+djin_version: '0.9.0'
+
+include:
+  - file: 'djin_lib/test.yml'
+    context:
+      variables:
+        namespace: 'test:'
+
+  - file: 'djin_lib/test.yml'
+    context:
+      variables:
+        namespace: 'test2:'
+
 
 tasks:
   default:
@@ -7,12 +19,6 @@ tasks:
       image: "ruby:2.5"
       run:
         - "ruby -e 'puts \\\" Hello\\\"'"
-  test:
-    docker-compose:
-      service: app
-      run:
-        commands: rspec
-        options: "--rm"
 
   script:
     docker:

data/examples/djin_lib/test.yml

@@ -0,0 +1,12 @@
+djin_version: '0.9.0'
+
+_default_run_options: &default_run_options
+  options: "--rm --entrypoint=''"
+
+tasks:
+  "{{namespace}}unit":
+    docker-compose:
+      service: app
+      run:
+        commands: "cd /usr/src/djin && rspec {{args}}"
+        <<: *default_run_options

data/examples/local_tasks/.djin/server_tasks.yml

@@ -0,0 +1,17 @@
+djin_version: '0.8.0'
+
+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

data/examples/local_tasks/djin.yml

@@ -0,0 +1,22 @@
+djin_version: '0.9.0'
+
+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
+
+tasks:
+  hello_command:
+    local:
+      run:
+        - echo 'Hello Djin'

data/lib/djin.rb

@@ -22,14 +22,15 @@ require 'djin/executor'
 require 'djin/cli'
 require 'djin/task_contract'
 require 'djin/repositories/task_repository'
+require 'djin/memory_cache'
 
 module Djin
   class Error < StandardError; end
 
-  def self.load_tasks!(path = Pathname.getwd.join('djin.yml'))
-    abort 'Error: djin.yml not found' unless path.exist?
+  def self.load_tasks!(file_path = Pathname.getwd.join('djin.yml'))
+    abort 'Error: djin.yml not found' unless file_path.exist?
 
-    file_config = ConfigLoader.load!(path.read)
+    file_config = ConfigLoader.load!(file_path)
 
     # TODO: Make all tasks be under 'tasks' key, passing only the tasks here
     tasks = Interpreter.load!(file_config)
@@ -48,4 +49,12 @@ module Djin
   def self.task_repository
     @task_repository ||= TaskRepository.new
   end
+
+  def self.cache
+    @cache ||= MemoryCache.new
+  end
+
+  def self.root_path
+    Pathname.new File.expand_path(File.dirname(__FILE__) + '/..')
+  end
 end

data/lib/djin/config_loader.rb

@@ -6,14 +6,16 @@ module Djin
   #       a TaskLoader
   class ConfigLoader
     using Djin::HashExtensions
-    RESERVED_WORDS = %w[djin_version variables tasks].freeze
+    RESERVED_WORDS = %w[djin_version variables tasks include].freeze
 
-    def self.load!(template_file)
-      new(template_file).load!
+    def self.load!(template_file, runtime_config: {})
+      new(template_file, runtime_config: runtime_config).load!
     end
 
-    def initialize(template_file)
+    def initialize(template_file, runtime_config: {})
       @template_file = template_file
+      @template_file_content = Djin.cache.fetch(template_file.realpath.to_s) { template_file.read }
+      @runtime_config = runtime_config
     end
 
     def load!
@@ -33,39 +35,21 @@ module Djin
       )
     end
 
-    def raw_djin_config
-      @raw_djin_config ||= yaml_load(@template_file)
-    rescue Psych::SyntaxError => e
-      raise Interpreter::InvalidConfigFileError, e.message
-    end
-
-    def rendered_djin_config
-      @rendered_djin_config ||= begin
-                                  locals = env.merge(variables)
-
-                                  rendered_yaml = Mustache.render(@template_file,
-                                                                  args: args.join(' '),
-                                                                  args?: args.any?,
-                                                                  **locals)
-                                  yaml_load(rendered_yaml)
-                                end
-    end
-
     def version
       # TODO: Deprecates djin_version and use version instead
       @version || raw_djin_config['djin_version']
     end
 
     def variables
-      @variables ||= raw_djin_config['variables']&.symbolize_keys || {}
+      @variables ||= included_variables.merge(raw_djin_config['variables']&.symbolize_keys || {})
     end
 
     def tasks
-      rendered_djin_config['tasks'] || legacy_tasks
+      included_tasks.merge(rendered_djin_config['tasks'] || legacy_tasks)
     end
 
     def raw_tasks
-      raw_djin_config['tasks'] || legacy_raw_tasks
+      included_raw_tasks.merge(raw_djin_config['tasks'] || legacy_raw_tasks)
     end
 
     def legacy_tasks
@@ -79,6 +63,34 @@ module Djin
       raw_djin_config.except(*RESERVED_WORDS).reject { |task| task.start_with?('_') }
     end
 
+    def included_variables
+      return {} unless included_config
+
+      included_config.variables
+    end
+
+    def included_tasks
+      return {} unless included_config
+
+      included_config.tasks
+    end
+
+    def included_raw_tasks
+      return {} unless included_config
+
+      included_config.raw_tasks
+    end
+
+    def included_config
+      @included_config ||= raw_djin_config['include']&.map do |tasks_reference|
+        external_config_file = Pathname.new(tasks_reference['file'])
+
+        ConfigLoader.load!(external_config_file, runtime_config: tasks_reference['context'] || {})
+      end&.reduce(:deep_merge)
+    rescue Errno::ENOENT => e
+      raise Interpreter::InvalidConfigFileError, e.message
+    end
+
     def args
       index = ARGV.index('--')
 
@@ -91,6 +103,24 @@ module Djin
       @env ||= ENV.to_h.symbolize_keys
     end
 
+    def raw_djin_config
+      @raw_djin_config ||= yaml_load(@template_file_content).deep_merge(@runtime_config)
+    rescue Psych::SyntaxError => e
+      raise Interpreter::InvalidConfigFileError, "File: #{@template_file.realpath}\n  #{e.message}"
+    end
+
+    def rendered_djin_config
+      @rendered_djin_config ||= begin
+                                  locals = env.merge(variables)
+
+                                  rendered_yaml = Mustache.render(@template_file_content,
+                                                                  args: args.join(' '),
+                                                                  args?: args.any?,
+                                                                  **locals)
+                                  yaml_load(rendered_yaml).merge(@runtime_config)
+                                end
+    end
+
     def yaml_load(text)
       YAML.safe_load(text, [], [], true)
     end

data/lib/djin/entities/file_config.rb

@@ -2,6 +2,8 @@
 
 module Djin
   class FileConfig < Dry::Struct
+    using HashExtensions
+
     attribute :djin_version, Types::String
     attribute :variables, Types::Hash.optional.default({}.freeze)
     attribute :tasks, Types::Hash
@@ -13,5 +15,17 @@ module Djin
     def version_supported?
       Vseries::SemanticVersion.new(Djin::VERSION) >= Vseries::SemanticVersion.new(djin_version)
     end
+
+    def merge(file_config)
+      merged_hash = to_h.merge(file_config.to_h)
+
+      FileConfig.new(merged_hash)
+    end
+
+    def deep_merge(file_config)
+      merged_hash = to_h.deep_merge(file_config.to_h)
+
+      FileConfig.new(merged_hash)
+    end
   end
 end

data/lib/djin/extensions/hash_extensions.rb

@@ -10,6 +10,20 @@ module Djin
       def symbolize_keys
         map { |key, value| [key.to_sym, value] }.to_h
       end
+
+      def deep_merge(other_hash)
+        dup.deep_merge!(other_hash)
+      end
+
+      def deep_merge!(other_hash)
+        merge!(other_hash) do |_, this_val, other_val|
+          if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+            this_val.deep_merge(other_val)
+          else
+            other_val
+          end
+        end
+      end
     end
   end
 end

data/lib/djin/interpreter.rb

@@ -12,22 +12,28 @@ module Djin
     InvalidSyntaxError = Class.new(InvalidConfigurationError)
 
     class << self
+      # rubocop:disable Metrics/AbcSize
       def load!(file_config)
-        contract = TaskContract.new
+        # TODO: Move task validation to ConfigLoader and add variables/include validations
+        task_contract = TaskContract.new
 
         file_config.tasks.map do |task_name, options|
-          result = contract.call(options)
+          result = task_contract.call(options)
 
           raise InvalidSyntaxError, { task_name.to_sym => result.errors.to_h } if result.failure?
 
           command, build_command = build_commands(options, task_name: task_name)
 
-          raw_command, = build_commands(file_config.raw_tasks[task_name], task_name: task_name)
+          # FIXME(1): Handle dynamic named tasks, eg: {{namespace}}unit and remove condition
+          if file_config.raw_tasks[task_name]
+            raw_command, = build_commands(file_config.raw_tasks[task_name], task_name: task_name)
+          end
 
           task_params = {
             name: task_name,
             build_command: build_command,
-            description: options['description'] || "Runs: #{raw_command}",
+            # TODO: Remove `|| command` after FIXME(1)
+            description: options['description'] || "Runs: #{raw_command || command}",
             command: command,
             raw_command: raw_command,
             aliases: options['aliases'],
@@ -37,6 +43,7 @@ module Djin
           Djin::Task.new(**task_params)
         end
       end
+      # rubocop:enable Metrics/AbcSize
 
       private
 

data/lib/djin/interpreter/base_command_builder.rb

@@ -17,6 +17,7 @@ module Djin
           run_options = run_params['options']
         end
 
+        # TODO: Remove empty values
         run_command = run_command.join(' && ') if run_command.is_a?(Array)
 
         [run_command, run_options]

data/lib/djin/memory_cache.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Djin
+  class MemoryCache
+    def initialize(hash_store = {})
+      @hash_store = hash_store
+    end
+
+    def fetch(key)
+      @hash_store[key] || @hash_store[key] = yield
+    end
+
+    def clear
+      @hash_store = {}
+    end
+  end
+end

data/lib/djin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Djin
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: djin
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Carlos Atkinson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-31 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -192,6 +192,9 @@ files:
 - djin.yml
 - docker-compose.yml
 - examples/djin.yml
+- examples/djin_lib/test.yml
+- examples/local_tasks/.djin/server_tasks.yml
+- examples/local_tasks/djin.yml
 - exe/djin
 - lib/djin.rb
 - lib/djin/cli.rb
@@ -206,6 +209,7 @@ files:
 - lib/djin/interpreter/docker_command_builder.rb
 - lib/djin/interpreter/docker_compose_command_builder.rb
 - lib/djin/interpreter/local_command_builder.rb
+- lib/djin/memory_cache.rb
 - lib/djin/repositories/task_repository.rb
 - lib/djin/task_contract.rb
 - lib/djin/version.rb