dip 8.0.0 → 8.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 027ac4456743eaef5ed3d2a461b15e57fcc13739500ef04bdedfca37b4c6c266
-  data.tar.gz: e5cdc4f2597241c242bc91f007ab35a2392feafbf924109f97f48ff330228997
+  metadata.gz: f0797622a68dc23c6c015addd9a97dfe57d9c5cca6b4981054dbac9f5f7602c9
+  data.tar.gz: bdb1277acfa498846fdd737a13058dc1dfc272fbd7196d21e4cbfeefaf13b3a6
 SHA512:
-  metadata.gz: 59685a0ab3f5d1174d58048d021b8f4f12d494aaa09773e0b0cfd05d4a2d12975c594efc7597b67e054912f5e6d75fdbd293ac7ca5ba69ab06af858f93dac1c5
-  data.tar.gz: 505a3e3657f17a0c01e1d785bfb23a86982ee42da7a8185ccf753de0116e7f18d082d66d11bac07031e43600c9397a74728de62e0a6d70191f9dbe939080f2da
+  metadata.gz: 826f6e63b2cd65d20f6bfc00b545a7b5f60d6068786df01f841d92de1179d69fcced9605f65a3e4bfbcace583e5a20e7e8a660359ff2922685a02fae60c8c5c3
+  data.tar.gz: 5e583069000503b70df8a8466605d905c4937b931b53734de57486662a93a1f1991a51363e46687eeb4664879ece0ae1c9db56f9a76b57a6e5c478fa5e8d4ee9

data/README.md

@@ -238,6 +238,92 @@ services:
 
 The container will run using the same user ID as your host machine.
 
+### Modules
+
+Modules are defined as array in `modules` section of dip.yml, modules are stored in `.dip` subdirectory of dip.yml directory.
+
+The main purpose of modules is to improve maintainability for a group of projects.
+Imagine having multiple gems which are managed with dip, each of them has the same commands, so to change one command in dip you need to update all gems individualy.
+
+With `modules` you can define a group of modules for dip.
+
+For example having setup as this:
+
+```yml
+# ./dip.yml
+modules:
+ - sasts
+ - rails
+
+...
+```
+
+```yml
+# ./.dip/sasts.yml
+interaction:
+  brakeman:
+    description: Check brakeman sast
+    command: docker run ...
+```
+
+```yml
+# ./.dip/rails.yml
+interaction:
+  annotate:
+    description: Run annotate command
+    service: backend
+    command: bundle exec annotate
+```
+
+Will be expanded to:
+
+```yml
+# resultant configuration
+interaction:
+  brakeman:
+    description: Check brakeman sast
+    command: docker run ...
+  annotate:
+    description: Run annotate command
+    service: backend
+    command: bundle exec annotate
+```
+
+Imagine `.dip` to be a submodule so it can be managed only in one place.
+
+If you want to override module command, you can redefine it in dip.yml
+
+```yml
+# ./dip.yml
+modules:
+ - sasts
+
+interaction:
+  brakeman:
+    description: Check brakeman sast
+    command: docker run another-image ...
+```
+
+```yml
+# ./.dip/sasts.yml
+interaction:
+  brakeman:
+    description: Check brakeman sast
+    command: docker run some-image ...
+```
+
+Will be expanded to:
+
+```yml
+# resultant configuration
+interaction:
+  brakeman:
+    description: Check brakeman sast
+    command: docker run another-image ...
+```
+
+Nested modules are not supported.
+
 ### dip run
 
 Run commands defined within the `interaction` section of dip.yml
@@ -386,6 +472,27 @@ services:
     user: "1000:1000"
 ```
 
+### dip validate
+
+Validates your dip.yml configuration against the JSON schema. The schema validation helps ensure your configuration is correct and follows the expected format.
+
+```sh
+dip validate
+```
+
+The validator will check:
+
+- Required properties are present
+- Property types are correct
+- Values match expected patterns
+- No unknown properties are used
+
+If validation fails, you'll get detailed error messages indicating what needs to be fixed.
+
+You can skip validation by setting `DIP_SKIP_VALIDATION` environment variable.
+
+Add `# yaml-language-server: $schema=https://raw.githubusercontent.com/bibendi/dip/refs/heads/master/schema.json` to the top of your dip.yml to get schema validation in VSCode. Read more about [YAML Language Server](https://github.com/redhat-developer/vscode-yaml?tab=readme-ov-file#associating-schemas).
+
 ## Changelog
 
 https://github.com/bibendi/dip/releases

data/lib/dip/cli.rb

@@ -5,7 +5,7 @@ require "dip/run_vars"
 
 module Dip
   class CLI < Thor
-    TOP_LEVEL_COMMANDS = %w[help version ls compose up stop down run provision ssh infra console].freeze
+    TOP_LEVEL_COMMANDS = %w[help version ls compose up stop down run provision ssh infra console validate]
 
     class << self
       # Hackery. Take the run method away from Thor so that we can redefine it.
@@ -117,6 +117,15 @@ module Dip
       end
     end
 
+    desc "validate", "Validate the dip.yml file against the schema"
+    def validate
+      Dip.config.validate
+      puts "dip.yml is valid"
+    rescue Dip::Error => e
+      warn "Validation failed: #{e.message}"
+      exit 1
+    end
+
     require_relative "cli/ssh"
     desc "ssh", "ssh-agent container commands"
     subcommand :ssh, Dip::CLI::SSH

data/lib/dip/config.rb

@@ -3,6 +3,7 @@
 require "yaml"
 require "erb"
 require "pathname"
+require "json-schema"
 
 require "dip/version"
 require "dip/ext/hash"
@@ -43,6 +44,10 @@ module Dip
         file_path&.exist?
       end
 
+      def modules_dir
+        file_path.dirname / ".dip"
+      end
+
       private
 
       attr_reader :override
@@ -90,6 +95,10 @@ module Dip
       finder.file_path
     end
 
+    def module_file(filename)
+      finder.modules_dir / "#{filename}.yml"
+    end
+
     def exist?
       finder.exist?
     end
@@ -104,6 +113,24 @@ module Dip
       end
     end
 
+    def validate
+      raise Dip::Error, "Config file path is not set" if file_path.nil?
+      raise Dip::Error, "Config file not found: #{file_path}" unless File.exist?(file_path)
+
+      schema_path = File.join(File.dirname(__FILE__), "../../schema.json")
+      raise Dip::Error, "Schema file not found: #{schema_path}" unless File.exist?(schema_path)
+
+      data = YAML.load_file(file_path)
+      schema = JSON.parse(File.read(schema_path))
+      JSON::Validator.validate!(schema, data)
+    rescue Psych::SyntaxError => e
+      raise Dip::Error, "Invalid YAML syntax in config file: #{e.message}"
+    rescue JSON::Schema::ValidationError => e
+      data_display = data ? data.to_yaml.gsub("\n", "\n  ") : "nil"
+      error_message = "Schema validation failed: #{e.message}\nInput data:\n  #{data_display}"
+      raise Dip::Error, error_message
+    end
+
     private
 
     attr_reader :work_dir
@@ -121,14 +148,38 @@ module Dip
 
       unless Gem::Version.new(Dip::VERSION) >= Gem::Version.new(config.fetch(:version))
         raise VersionMismatchError, "Your dip version is `#{Dip::VERSION}`, " \
-                                    "but config requires minimum version `#{config[:version]}`. " \
-                                    "Please upgrade your dip!"
+                                   "but config requires minimum version `#{config[:version]}`. " \
+                                   "Please upgrade your dip!"
       end
 
+      base_config = {}
+
+      if (modules = config[:modules])
+        raise Dip::Error, "Modules should be specified as array" unless modules.is_a?(Array)
+
+        modules.each do |m|
+          file = module_file(m)
+          raise Dip::Error, "Could not find module `#{m}`" unless file.exist?
+
+          module_config = self.class.load_yaml(file)
+          raise Dip::Error, "Nested modules are not supported" if module_config[:modules]
+
+          base_config.deep_merge!(module_config)
+        end
+      end
+
+      base_config.deep_merge!(config)
+
       override_finder = ConfigFinder.new(work_dir, override: true)
-      config.deep_merge!(self.class.load_yaml(override_finder.file_path)) if override_finder.exist?
+      base_config.deep_merge!(self.class.load_yaml(override_finder.file_path)) if override_finder.exist?
+
+      @config = CONFIG_DEFAULTS.merge(base_config)
+
+      unless ENV.key?("DIP_SKIP_VALIDATION")
+        validate
+      end
 
-      @config = CONFIG_DEFAULTS.merge(config)
+      @config
     end
 
     def config_missing_error(config_key)

data/lib/dip/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dip
-  VERSION = "8.0.0"
+  VERSION = "8.2.0"
 end

data/schema.json

@@ -0,0 +1,224 @@
+{
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "title": "Dip Configuration Schema",
+  "description": "Schema for the dip.yml configuration file",
+  "type": "object",
+  "additionalProperties": false,
+  "definitions": {
+    "environment_vars": {
+      "type": "object",
+      "description": "Defines environment variables",
+      "additionalProperties": {
+        "type": "string"
+      },
+      "examples": [
+        { "RAILS_ENV": "development" },
+        { "DATABASE_URL": "postgres://user:password@db:5432/myapp_development" },
+        { "PORT": "${PORT:-3000}" }
+      ]
+    },
+    "interaction_command": {
+      "type": "object",
+      "description": "Configuration for an interaction command",
+      "additionalProperties": false,
+      "properties": {
+        "description": {
+          "type": "string",
+          "description": "Describes the command",
+          "examples": ["Run Rails commands", "Connect to PostgreSQL database"]
+        },
+        "service": {
+          "type": "string",
+          "description": "Specifies the service associated with the command",
+          "examples": ["web", "frontend", "db"]
+        },
+        "command": {
+          "type": "string",
+          "description": "Represents the command to be executed",
+          "examples": ["bundle exec rails", "npm", "psql -h db -U user myapp_development"]
+        },
+        "default_args": {
+          "type": "string",
+          "description": "Default arguments for the command",
+          "examples": ["server -p 3000 -b 0.0.0.0"]
+        },
+        "environment": {
+          "$ref": "#/definitions/environment_vars"
+        },
+        "compose": {
+          "type": "object",
+          "description": "Allows specifying Docker Compose options",
+          "additionalProperties": false,
+          "properties": {
+            "method": {
+              "type": "string",
+              "description": "Specifies the Docker Compose method (e.g., up, run)",
+              "examples": ["run", "up"]
+            },
+            "compose_method": {
+              "type": "string",
+              "description": "Specifies an alternative Docker Compose method to use in compose commands",
+              "examples": ["up"]
+            },
+            "run_options": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Options to pass to the 'docker-compose run' command",
+              "examples": [["service-ports", "rm"]]
+            },
+            "profiles": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Docker Compose profiles to use",
+              "examples": [["web", "development"], ["frontend"], ["test"]]
+            }
+          }
+        },
+        "shell": {
+          "type": "boolean",
+          "description": "Enables or disables shell interpolation"
+        },
+        "entrypoint": {
+          "type": "string",
+          "description": "Specifies the command entrypoint"
+        },
+        "runner": {
+          "type": "string",
+          "description": "Specifies the runner (e.g., docker_compose, kubectl)"
+        },
+        "subcommands": {
+          "type": "object",
+          "description": "Contains subcommands with the same structure as main commands",
+          "patternProperties": {
+            "^[a-zA-Z0-9_]+$": {
+              "$ref": "#/definitions/interaction_command"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      }
+    }
+  },
+  "properties": {
+    "version": {
+      "type": "string",
+      "description": "Specifies the minimum required version of Dip",
+      "examples": ["8.1.0"]
+    },
+    "compose": {
+      "type": "object",
+      "description": "Contains Docker Compose configuration",
+      "properties": {
+        "files": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Array of strings representing paths to Docker Compose files",
+          "examples": [["docker-compose.yml", "docker-compose.override.yml"]]
+        },
+        "project_name": {
+          "type": "string",
+          "description": "Specifies the project name for Docker Compose",
+          "examples": ["app"]
+        },
+        "command": {
+          "type": "string",
+          "description": "Specifies an alternative Docker Compose command",
+          "examples": ["docker compose"]
+        },
+        "method": {
+          "type": "string",
+          "description": "Specifies the Docker Compose method to use"
+        }
+      }
+    },
+    "interaction": {
+      "type": "object",
+      "description": "Defines the commands and their configurations",
+      "patternProperties": {
+        "^[a-zA-Z0-9_]+$": {
+          "$ref": "#/definitions/interaction_command"
+        }
+      },
+      "additionalProperties": false
+    },
+    "provision": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "Lists the commands to be executed for provisioning",
+      "examples": [
+        [
+          "dip compose down --volumes",
+          "dip compose build",
+          "dip rails db:migrate",
+          "dip npm install"
+        ]
+      ]
+    },
+    "environment": {
+      "$ref": "#/definitions/environment_vars"
+    },
+    "kubectl": {
+      "type": "object",
+      "description": "Contains Kubernetes configuration",
+      "additionalProperties": false,
+      "properties": {
+        "namespace": {
+          "type": "string",
+          "description": "Specifies the Kubernetes namespace to use",
+          "examples": ["app"]
+        }
+      }
+    },
+    "modules": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "Paths to module configuration files",
+      "examples": [["production"]]
+    },
+    "infra": {
+      "type": "object",
+      "description": "Contains infrastructure services configuration",
+      "additionalProperties": false,
+      "patternProperties": {
+        "^[a-zA-Z0-9_]+$": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "git": {
+              "type": "string",
+              "pattern": "^(git@|git://|https?://)[\\w\\d\\.@:\\-/]+$",
+              "description": "Git repository URL for the infrastructure component",
+              "examples": ["https://github.com/mycompany/redis-config.git"]
+            },
+            "ref": {
+              "type": "string",
+              "description": "Specifies the Git reference (branch, tag, or commit) to use",
+              "examples": ["main"]
+            },
+            "path": {
+              "type": "string",
+              "description": "Local path to the infrastructure component",
+              "examples": ["./infra/elasticsearch"]
+            }
+          },
+          "oneOf": [
+            { "required": ["git", "ref"] },
+            { "required": ["path"] }
+          ]
+        }
+      }
+    }
+  },
+  "required": ["version", "interaction"]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dip
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.2.0
 platform: ruby
 authors:
 - bibendi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-29 00:00:00.000000000 Z
+date: 2024-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -30,6 +30,40 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: public_suffix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -212,6 +246,7 @@ files:
 - lib/dip/interaction_tree.rb
 - lib/dip/run_vars.rb
 - lib/dip/version.rb
+- schema.json
 homepage: https://github.com/bibendi/dip
 licenses:
 - MIT
@@ -232,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: Ruby gem CLI tool for better interacting Docker Compose files.