ddsl 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc50eec07295a16c3ecd6a8be51092c807574804
-  data.tar.gz: 5d752cc123531436e14ac1697638826a6dc38e9e
+  metadata.gz: cbf0d40e7957eb4db36772b305282892b5084f2c
+  data.tar.gz: 447843b863036959416cb10ab4ced57da3fd70c2
 SHA512:
-  metadata.gz: a37dc864649a554971209c92280934618c8140fc8f9b8dbe67153078aaccf6d889c55de6a04f11808835f6d5ca30a65ded1c5de026b4df651ca1e76a0c064e01
-  data.tar.gz: eda8481c21285581092ccafba56b4c8d0bb18143fb3940ced1931b3dcf01630218b78252b84bf21bd1b209096f1fa192baa27b0a33e7011232cef36009de93e7
+  metadata.gz: e879a19bda67f10c326dd8155f3637c7630e8bb05a8728bd27d931878bcd0eb7aff0480d688b5c11ad4e883bc01ecd2b3dd1c8f4f861e63af8c81ad89d7a3a5e
+  data.tar.gz: 4296bae73cb2db3525c66e591c315b09685f78aec50234c8ba6db06db2bd567d59fd9ec311b7e5fb6a189a2344eb6b0d170e5be706e14b41b7d135406ded7673

data/.circleci/config.yml

@@ -23,8 +23,6 @@ jobs:
     steps:
       - checkout
       - setup_remote_docker
-      - run:
-          command: echo "$DOCKER_REGISTRY_PASSWORD" | docker login --username $DOCKER_REGISTRY_USERNAME --password-stdin
       - run:
           command: |
             export CI_SHA1=circleci-$CIRCLE_SHA1
@@ -34,8 +32,6 @@ jobs:
     steps:
       - checkout
       - setup_remote_docker
-      - run:
-          command: echo "$DOCKER_REGISTRY_PASSWORD" | docker login --username $DOCKER_REGISTRY_USERNAME --password-stdin
       - run:
           command: |
             export CI_SHA1=circleci-$CIRCLE_SHA1
@@ -45,8 +41,6 @@ jobs:
     steps:
       - checkout
       - setup_remote_docker
-      - run:
-          command: echo "$DOCKER_REGISTRY_PASSWORD" | docker login --username $DOCKER_REGISTRY_USERNAME --password-stdin
       - run:
           command: |
             export CI_SHA1=circleci-$CIRCLE_SHA1

data/.ddsl.yml

@@ -1,5 +1,11 @@
 version: 1
 
+registries:
+  - url: docker.io
+    username: $DOCKER_REGISTRY_USERNAME
+    password: $DOCKER_REGISTRY_PASSWORD
+    use_cache: true
+
 builds:
   - name: feature-branch
     type: docker
@@ -34,14 +40,14 @@ runs:
     type: docker
     image: bilby91/ddsl:$CI_SHA1
     cmd: bundle exec rspec spec
-  - name: test
-    type: docker
-    image: bilby91/ddsl:latest
-    cmd: bundle exec rspec spec
   - name: lint-ci
     type: docker
     image: bilby91/ddsl:$CI_SHA1
     cmd: rubocop .
+  - name: test
+    type: docker
+    image: bilby91/ddsl:latest
+    cmd: bundle exec rspec spec
   - name: lint
     type: docker
     image: bilby91/ddsl:latest

data/.gitlab-ci.yml

@@ -10,7 +10,6 @@ stages:
   - build
   - checks
 before_script:
-  - echo $DOCKER_REGISTRY_PASSWORD | docker login -u "$DOCKER_REGISTRY_USERNAME" --password-stdin
   - export CI_SHA1=gitlab-$CI_COMMIT_SHA
 build:
   stage: build

data/.travis.yml

@@ -7,7 +7,7 @@ services:
 
 env:
   global:
-    - DDSL_VERSION=0.0.2
+    - DDSL_VERSION=0.0.3
     - DOCKER_COMPOSE_VERSION=1.23.1
 
 stages:
@@ -19,7 +19,6 @@ before_install:
   - curl -L https://github.com/docker/compose/releases/download/${DOCKER_COMPOSE_VERSION}/docker-compose-`uname -s`-`uname -m` > docker-compose
   - chmod +x docker-compose
   - sudo mv docker-compose /usr/local/bin
-  - docker login -u "$DOCKER_REGISTRY_USERNAME" -p "$DOCKER_REGISTRY_PASSWORD"
   - export CI_SHA1=travis-$TRAVIS_COMMIT
 
 install: gem install ddsl --version=$DDSL_VERSION

data/Gemfile.lock

@@ -1,31 +1,35 @@
 PATH
   remote: .
   specs:
-    ddsl (0.0.2)
+    ddsl (0.0.4)
       clamp (~> 1)
       json (~> 2)
-      json-schema (~> 2)
+      json_schemer (~> 0.1)
       transproc (~> 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
     ast (2.4.0)
     clamp (1.3.0)
     diff-lcs (1.3)
     docile (1.3.1)
+    ecma-re-validator (0.2.0)
+      regexp_parser (~> 1.2)
+    hana (1.3.4)
     jaro_winkler (1.5.1)
     json (2.1.0)
-    json-schema (2.8.1)
-      addressable (>= 2.4)
+    json_schemer (0.1.9)
+      ecma-re-validator (~> 0.2.0)
+      hana (~> 1.3.3)
+      regexp_parser (~> 1.2.0)
+      uri_template (~> 0.7.0)
     parallel (1.12.1)
     parser (2.5.3.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
-    public_suffix (3.0.3)
     rainbow (3.0.0)
+    regexp_parser (1.2.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -53,8 +57,9 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    transproc (1.0.2)
+    transproc (1.0.3)
     unicode-display_width (1.4.0)
+    uri_template (0.7.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -2,7 +2,11 @@
 
 Docker Declarative Specific Language
 
-`ddsl` lets you declare how your docker images are built and what checks (test, linter, etc) need be run in your images.
+`ddsl` allow developers to express in a declarative way how application are built, run and tested. Building, running and testing applications should be semlessly, independently on what environment your are. `ddsl` makes the latter easy by providing one cli to use in CI and development environments.
+
+## Usage
+
+`ddsl` it's a command line tool that works with a companion `.ddsl.yml` file. In the `.ddsl.yml` file you can declare the diferent builds and runs that your application will need. A very simple example would look like this:
 
 ```yaml
 version: 1
@@ -55,13 +59,31 @@ runs:
     cmd: rubocop .
 ```
 
+In order to run the `feature-branch` build for example, you would need to invoke the `ddsl` like this:
+
+`ddsl build feature-branch`
+
+Or maybe you want to run you tests
+
+`ddsl run test`
+
+Or maybe you want to run your tests and also lint your code
+
+`ddsl run test lint`
+
+## Documentation
+
+The best documentation at this moment is looking at the source code of the project. `ddsl` uses itself to run in CI and developers use it to run in their development environments. Take a look at `.ddsl.yml` file in the root of the repository for more information.
+
+Full documentation of the schema can be found here https://github.com/bilby91/ddsl/blob/master/docs/ddsl.schema.md
+
 ## Contnious Integration
 
 | Provider  | Status                                                                                                                                   |
 |-----------|------------------------------------------------------------------------------------------------------------------------------------------|
 | GitLab CI | [![Gitlab CI](https://img.shields.io/gitlab/pipeline/bilby91/ddsl/master.svg)](https://gitlab.com/bilby91/ddsl)                          |
 | Circle CI | [![Circle CI](https://img.shields.io/circleci/project/github/bilby91/ddsl/master.svg)](https://circleci.com/gh/bilby91/ddsl/tree/master) |
-| Travis CI | [![Travis CI](https://img.shields.io/travis/bilby91/ddsl/master.svg)](https://travis-ci.com/bilby91/ddsl)                                |
+| Travis CI | [![Travis CI](https://img.shields.io/travis/com/bilby91/ddsl/master.svg)](https://travis-ci.com/bilby91/ddsl)                                |
 
 ## Dependencies
 
@@ -69,17 +91,7 @@ runs:
 - docker
 - docker-compose
 
-## TODO
-
-- [X] Docker Compose support
-- [X] Variable interpolation
-- [X] Add CircleCI
-- [X] Add GitLabCI
-- [X] Add TravisCI
-- [X] Registries?
-- [ ] Variable sharing/reusing
-- [ ] External secret proviers ? (KMS, Google?)
-
 ## Contact
 
-- Martín Fernández <fmartin91@gmail.com>
+- Martín Fernández <fmartin91@gmail.com>
+- Iván Etchart <ivan.etchart@me.com>

data/ddsl.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.add_dependency 'clamp', '~> 1'
   spec.add_dependency 'json', '~> 2'
-  spec.add_dependency 'json-schema', '~> 2'
+  spec.add_dependency 'json_schemer', '~> 0.1'
   spec.add_dependency 'transproc', '~> 1'
   spec.add_development_dependency 'rspec', '~> 3'
   spec.add_development_dependency 'rubocop', '~> 0.60'

data/docker/Dockerfile

@@ -43,4 +43,4 @@ RUN gem build ddsl.gemspec
 
 # Install binary
 # FIXME: We need to load the version dynamically
-RUN gem install --no-rdoc --no-ri --local ddsl-0.0.3.gem
+RUN gem install --no-rdoc --no-ri --local ddsl-0.0.4.gem

data/docs/build.schema.json

@@ -0,0 +1,141 @@
+{
+    "$schema": "http://json-schema.org/draft-06/schema#",
+    "$id": "https://raw.githubusercontent.com/bilby91/ddsl/master/docs/build.schema.json",
+    "title": "Build",
+    "description": "Build task to perform using either docker or docker-compose",
+    "type": "object",
+    "required": [
+        "name"
+    ],
+    "oneOf": [
+        {
+            "$ref": "#/definitions/build_docker_options"
+        },
+        {
+            "$ref": "#/definitions/build_docker_compose_options"
+        }
+    ],
+    "properties": {
+        "name": {
+            "type": "string",
+            "description": "Unique name to identify the build task."
+        }
+    },
+    "definitions": {
+        "build_docker_options": {
+            "type": "object",
+            "required": [
+                "type",
+                "context",
+                "file"
+            ],
+            "properties": {
+                "type": {
+                    "type": "string",
+                    "enum": [
+                        "docker"
+                    ],
+                    "description": "Type of builder to use"
+                },
+                "context": {
+                    "type": "string",
+                    "description": "Path for the `docker build` context"
+                },
+                "file": {
+                    "type": "string",
+                    "description": "Path to the Dockerfile to build"
+                },
+                "build_args": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": "string"
+                    },
+                    "description": "Set build-time variables"
+                },
+                "tags": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "description": "Name and optionally a tag in the ‘name:tag’ format"
+                },
+                "labels": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "description": "Set metadata for an image"
+                },
+                "cache_from": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "description": "Images to consider as cache sources"
+                },
+                "push": {
+                    "type": "boolean",
+                    "description": "If true, push any configured tag to the appropiate registry"
+                },
+                "pull": {
+                    "type": "boolean",
+                    "description": "If true, all images specified in `cache_from` will be pulled before building"
+                }
+            }
+        },
+        "build_docker_compose_options": {
+            "type": "object",
+            "required": [
+                "type"
+            ],
+            "properties": {
+                "type": {
+                    "type": "string",
+                    "enum": [
+                        "docker-compose"
+                    ],
+                    "description": "Type of builder to use"
+                },
+                "file": {
+                    "type": "string",
+                    "description": "Path to the docker-compose file"
+                },
+                "service": {
+                    "type": "string",
+                    "description": "Name of the docker-compose service to build"
+                },
+                "no_cache": {
+                    "type": "boolean",
+                    "description": "Do not use cache when building the image"
+                },
+                "pull": {
+                    "type": "boolean",
+                    "description": "Always attempt to pull a newer version of the image"
+                },
+                "force_rm": {
+                    "type": "boolean",
+                    "description": "Always remove intermediate containers"
+                },
+                "compress": {
+                    "type": "boolean",
+                    "description": "Compress the build context using gzip"
+                },
+                "parallel": {
+                    "type": "boolean",
+                    "description": "Build images in parallel"
+                },
+                "memory": {
+                    "type": "string",
+                    "description": "Sets memory limit for the build container."
+                },
+                "build_args": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": "string"
+                    },
+                    "description": "Set build-time variables for services"
+                }
+            }
+        }
+    }
+}

data/docs/build.schema.md

@@ -0,0 +1,383 @@
+
+# Build Schema
+
+```
+https://raw.githubusercontent.com/bilby91/ddsl/master/docs/build.schema.json
+```
+
+Build task to perform using either docker or docker-compose
+
+| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In |
+|----------|------------|--------|--------------|-------------------|-----------------------|------------|
+| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [build.schema.json](build.schema.json) |
+
+# Build Properties
+
+| Property | Type | Required | Defined by |
+|----------|------|----------|------------|
+| [name](#name) | `string` | **Required** | Build (this schema) |
+| `*` | any | Additional | this schema *allows* additional properties |
+
+## name
+
+Unique name to identify the build task.
+
+`name`
+
+* is **required**
+* type: `string`
+* defined in this schema
+
+### name Type
+
+
+`string`
+
+
+
+
+
+
+
+# Build Definitions
+
+| Property | Type | Group |
+|----------|------|-------|
+| [build_args](#build_args) | `object` | `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/build.schema.json#/definitions/build_docker_compose_options` |
+| [cache_from](#cache_from) | `string[]` | `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/build.schema.json#/definitions/build_docker_options` |
+| [compress](#compress) | `boolean` | `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/build.schema.json#/definitions/build_docker_compose_options` |
+| [context](#context) | `string` | `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/build.schema.json#/definitions/build_docker_options` |
+| [file](#file) | `string` | `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/build.schema.json#/definitions/build_docker_compose_options` |
+| [force_rm](#force_rm) | `boolean` | `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/build.schema.json#/definitions/build_docker_compose_options` |
+| [labels](#labels) | `string[]` | `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/build.schema.json#/definitions/build_docker_options` |
+| [memory](#memory) | `string` | `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/build.schema.json#/definitions/build_docker_compose_options` |
+| [no_cache](#no_cache) | `boolean` | `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/build.schema.json#/definitions/build_docker_compose_options` |
+| [parallel](#parallel) | `boolean` | `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/build.schema.json#/definitions/build_docker_compose_options` |
+| [pull](#pull) | `boolean` | `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/build.schema.json#/definitions/build_docker_compose_options` |
+| [push](#push) | `boolean` | `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/build.schema.json#/definitions/build_docker_options` |
+| [service](#service) | `string` | `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/build.schema.json#/definitions/build_docker_compose_options` |
+| [tags](#tags) | `string[]` | `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/build.schema.json#/definitions/build_docker_options` |
+| [type](#type) | `enum` | `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/build.schema.json#/definitions/build_docker_compose_options` |
+
+## build_args
+
+Set build-time variables for services
+
+`build_args`
+
+* is optional
+* type: `object`
+* defined in this schema
+
+### build_args Type
+
+
+`object` with following properties:
+
+
+| Property | Type | Required |
+|----------|------|----------|
+
+
+
+
+
+
+## cache_from
+
+Images to consider as cache sources
+
+`cache_from`
+
+* is optional
+* type: `string[]`
+* defined in this schema
+
+### cache_from Type
+
+
+Array type: `string[]`
+
+All items must be of the type:
+`string`
+
+
+
+
+
+
+
+
+
+
+## compress
+
+Compress the build context using gzip
+
+`compress`
+
+* is optional
+* type: `boolean`
+* defined in this schema
+
+### compress Type
+
+
+`boolean`
+
+
+
+
+
+## context
+
+Path for the `docker build` context
+
+`context`
+
+* is optional
+* type: `string`
+* defined in this schema
+
+### context Type
+
+
+`string`
+
+
+
+
+
+
+
+## file
+
+Path to the docker-compose file
+
+`file`
+
+* is optional
+* type: `string`
+* defined in this schema
+
+### file Type
+
+
+`string`
+
+
+
+
+
+
+
+## force_rm
+
+Always remove intermediate containers
+
+`force_rm`
+
+* is optional
+* type: `boolean`
+* defined in this schema
+
+### force_rm Type
+
+
+`boolean`
+
+
+
+
+
+## labels
+
+Set metadata for an image
+
+`labels`
+
+* is optional
+* type: `string[]`
+* defined in this schema
+
+### labels Type
+
+
+Array type: `string[]`
+
+All items must be of the type:
+`string`
+
+
+
+
+
+
+
+
+
+
+## memory
+
+Sets memory limit for the build container.
+
+`memory`
+
+* is optional
+* type: `string`
+* defined in this schema
+
+### memory Type
+
+
+`string`
+
+
+
+
+
+
+
+## no_cache
+
+Do not use cache when building the image
+
+`no_cache`
+
+* is optional
+* type: `boolean`
+* defined in this schema
+
+### no_cache Type
+
+
+`boolean`
+
+
+
+
+
+## parallel
+
+Build images in parallel
+
+`parallel`
+
+* is optional
+* type: `boolean`
+* defined in this schema
+
+### parallel Type
+
+
+`boolean`
+
+
+
+
+
+## pull
+
+Always attempt to pull a newer version of the image
+
+`pull`
+
+* is optional
+* type: `boolean`
+* defined in this schema
+
+### pull Type
+
+
+`boolean`
+
+
+
+
+
+## push
+
+If true, push any configured tag to the appropiate registry
+
+`push`
+
+* is optional
+* type: `boolean`
+* defined in this schema
+
+### push Type
+
+
+`boolean`
+
+
+
+
+
+## service
+
+Name of the docker-compose service to build
+
+`service`
+
+* is optional
+* type: `string`
+* defined in this schema
+
+### service Type
+
+
+`string`
+
+
+
+
+
+
+
+## tags
+
+Name and optionally a tag in the ‘name:tag’ format
+
+`tags`
+
+* is optional
+* type: `string[]`
+* defined in this schema
+
+### tags Type
+
+
+Array type: `string[]`
+
+All items must be of the type:
+`string`
+
+
+
+
+
+
+
+
+
+
+## type
+
+Type of builder to use
+
+`type`
+
+* is optional
+* type: `enum`
+* defined in this schema
+
+The value of this property **must** be equal to one of the [known values below](#type-known-values).
+
+### type Known Values
+| Value | Description |
+|-------|-------------|
+| `docker-compose` |  |
+
+
+