Merge pull request #14 from codenamephp/resources

Recreating recipes as resources

.travis.yml

@@ -23,11 +23,11 @@ install:
 - eval "$(chef shell-init bash)"
 - openssl aes-256-cbc -K $encrypted_f6ac716f1c72_key -iv $encrypted_f6ac716f1c72_iv -in codenamephp.pem.enc -out codenamephp.pem -d
 
-script: 
+script:
   - chef exec foodcritic .
   - chef exec rubocop
   - chef exec rspec
-  - travis_retry chef exec kitchen test
+  - chef exec kitchen test
 
 before_deploy:
   - chef exec knife cookbook metadata from file metadata.rb

.vscode/tasks.json

@@ -0,0 +1,59 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=733558
+  // for the documentation about the tasks.json format
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Rubocop",
+      "type": "shell",
+      "command": "rubocop -a",
+      "group": "test"
+    },
+    {
+      "label": "Foodcritic",
+      "type": "shell",
+      "command": "foodcritic .",
+      "group": "test"
+    },
+    {
+      "label": "RSpec",
+      "type": "shell",
+      "command": "rspec",
+      "group": "test"
+    },
+    {
+      "label": "Kitchen Test",
+      "type": "shell",
+      "command": "kitchen test"
+    },
+    {
+      "label": "Lint",
+      "dependsOn": [
+        "Rubocop",
+        "Foodcritic"
+      ],
+      "problemMatcher": []
+    },
+    {
+      "label": "Unit",
+      "dependsOn": [
+        "RSpec"
+      ]
+    },
+    {
+      "label": "Integration",
+      "dependsOn": [
+        "Kitchen Test"
+      ]
+    },
+    {
+      "label": "All",
+      "dependsOn": [
+        "Lint",
+        "Unit",
+        "Integration"
+      ],
+      "problemMatcher": []
+    }
+  ]
+}

Berksfile

@@ -4,4 +4,4 @@ source 'https://supermarket.chef.io'
 
 metadata
 
-# cookbook 'test', path: './test/fixtures/cookbooks/test', group: :test
+cookbook 'test', path: './test/fixtures/cookbooks/test', group: :test

MIGRATION.md

@@ -0,0 +1,5 @@
+# 3.0
+
+The recipes have been removed. Create a wrapper cookbook and use the resource there as needed. The service recipe was replaced by
+the `codenamephp_docker_service` resource that does exactly the same as the recipe did. For docker-compose there is the
+`codenamephp_docker_compose` resource

README.md

@@ -23,20 +23,46 @@ This is just a wrapper cookbook for [docker][docker-github]
 Add the cookbook to your Berksfile:
 
 ```ruby
-cookbook 'codenamephp_docker', :github 'codenamephp/codenamephp_docker'
+cookbook 'codenamephp_docker'
 ```
 
-Add the cookbook to your runlist, e.g. in a role:
-
-```json
-{
-  "name": "default",
-  "chef_type": "role",
-  "json_class": "Chef::Role",
-  "run_list": [
-	  "recipe[codenamephp_docker]"
-  ]
-}
+Use the resources as needed in a wrapper cookbook. You can check out some examples either in this readme or in the test/fixtures/test cookbook.
+
+## Resources
+### Service
+Uses the `docker_service` resource to install docker and create and start the service.
+
+#### Actions
+- `install`: Installs docker and creates and starts the service
+
+#### Examples
+With minimal properties:
+```ruby
+# Install
+codenamephp_docker_service 'Install docker'
+```
+
+### Compose
+Installs docker-compose as a docker image using the run script wrapper from docker-compose github. The bash completion is also installed.
+
+#### Actions
+- `install`: Installs docker-compose and bash completion
+
+#### Properties
+- `version`: The desired version as string, defaults to `'latest'`
+
+#### Examples
+With minimal properties:
+```ruby
+# Install
+codenamephp_docker_service 'Install docker'
+```
+
+With custom version:
+```ruby
+codenamephp_docker_compose 'Install docker-compose' do
+  version '1.26.1'
+end
 ```
 
 [docker-github]: https://github.com/chef-cookbooks/docker

kitchen.dokken.yml

@@ -2,15 +2,15 @@ driver:
   name: dokken
   chef_version: current
   privileged: true # because Docker and SystemD/Upstart
-    
+
 transport:
   name: dokken
 
 provisioner:
   name: dokken
   deprecations_as_errors: true
   chef_license: accept
-  
+
 platforms:
   - name: debian-10
     driver:

kitchen.yml

@@ -14,8 +14,8 @@ platforms:
 suites:
   - name: default
     run_list:
-      - recipe[codenamephp_docker::default]
+      - recipe[test]
     verifier:
       inspec_tests:
-        - test/smoke/default
+        - test/integration/default
     attributes:

metadata.rb

@@ -5,8 +5,8 @@
 maintainer_email '[email protected]'
 license 'Apache-2.0'
 description 'Installs/Configures codenamephp_docker'
-version '2.0.0'
-chef_version '>= 13.0' if respond_to?(:chef_version)
+version '3.0.0'
+chef_version '>= 13.0'
 issues_url 'https://github.com/codenamephp/chef.cookbook.docker/issues'
 source_url 'https://github.com/codenamephp/chef.cookbook.docker'
 

resources/compose.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+property :version, String, default: 'latest', description: 'The version of docker-compose to install, defaults to "latest"'
+
+action :install do
+  remote_file 'download docker-compose' do
+    source compose_url
+    path '/usr/local/bin/docker-compose'
+    owner 'root'
+    group 'root'
+    mode '0755'
+    action :create
+  end
+
+  directory 'create bash completion directory' do
+    path '/etc/bash_completion.d'
+    owner 'root'
+    group 'root'
+    mode '0755'
+    recursive true
+    action :create
+  end
+
+  remote_file 'download bash completion' do
+    source lazy { compose_bash_completion_url }
+    path '/etc/bash_completion.d/docker-compose'
+    owner 'root'
+    group 'root'
+    mode '0755'
+    action :create
+  end
+end
+
+action_class do
+  def compose_url
+    distro = Mixlib::ShellOut.new('uname -s').run_command.stdout.strip
+    arch = Mixlib::ShellOut.new('uname -m').run_command.stdout.strip
+    file = "docker-compose-#{distro}-#{arch}"
+
+    new_resource.version == 'latest' ? "https://github.com/docker/compose/releases/latest/download/#{file}" : "https://github.com/docker/compose/releases/download/#{new_resource.version}/#{file}"
+  end
+
+  def compose_bash_completion_url
+    version = Mixlib::ShellOut.new("docker-compose -v | grep version | awk -F'[ ,]+' '{print $3}'").run_command.stdout.strip
+    "https://raw.githubusercontent.com/docker/compose/#{version}/contrib/completion/bash/docker-compose"
+  end
+end

resources/service.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+action :install do
+  docker_service 'default' do
+    action %i[create start]
+  end
+end