Merge pull request #218 from alxwr/make-composer-dependencies-configurable

feat(composer): make dependencies configurable

Author: myii

.github/workflows/kitchen.vagrant.yml

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+# vim: ft=yaml
+---
+name: 'Kitchen Vagrant (FreeBSD)'
+'on': ['push', 'pull_request']
+
+env:
+  KITCHEN_LOCAL_YAML: 'kitchen.vagrant.yml'
+
+jobs:
+  test:
+    runs-on: 'macos-10.15'
+    strategy:
+      fail-fast: false
+      matrix:
+        instance:
+          - freebsd-freebsd-122-latest-py3
+          - freebsd-freebsd-114-latest-py3
+    steps:
+      - name: 'Check out code'
+        uses: 'actions/checkout@v2'
+      - name: 'Set up Bundler cache'
+        uses: 'actions/cache@v1'
+        with:
+          path: 'vendor/bundle'
+          key: "${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}"
+          restore-keys: "${{ runner.os }}-gems-"
+      - name: 'Run Bundler'
+        run: |
+          ruby --version
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+      - name: 'Run Test Kitchen'
+        run: 'bundle exec kitchen verify ${{ matrix.instance }}'

Gemfile

@@ -12,3 +12,7 @@ gem 'kitchen-docker', git: 'https://gitlab.com/saltstack-formulas/infrastructure
 # rubocop:enable Layout/LineLength
 gem 'kitchen-inspec', '>= 2.2.1'
 gem 'kitchen-salt', '>= 0.6.3'
+
+group :vagrant do
+  gem 'kitchen-vagrant'
+end

Gemfile.lock

@@ -292,6 +292,8 @@ GEM
     kitchen-salt (0.6.3)
       hashie (>= 3.5)
       test-kitchen (>= 1.4)
+    kitchen-vagrant (1.7.0)
+      test-kitchen (>= 1.4, < 3)
     libyajl2 (1.2.0)
     license-acceptance (1.0.19)
       pastel (~> 0.7)
@@ -525,6 +527,7 @@ DEPENDENCIES
   kitchen-docker!
   kitchen-inspec (>= 2.2.1)
   kitchen-salt (>= 0.6.3)
+  kitchen-vagrant
 
 BUNDLED WITH
    2.1.2

kitchen.vagrant.yml

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+# vim: ft=yaml
+---
+driver:
+  name: vagrant
+  cache_directory: false
+  customize:
+    usbxhci: 'off'
+  gui: false
+  linked_clone: true
+  ssh:
+    shell: /bin/sh
+
+platforms:
+  - name: freebsd-122-latest-py3
+    driver:
+      box: bento/freebsd-12.2
+  - name: freebsd-114-latest-py3
+    driver:
+      box: bento/freebsd-11.4
+
+provisioner:
+  salt_install: bootstrap

kitchen.yml

@@ -455,3 +455,23 @@ suites:
     verifier:
       inspec_tests:
         - path: test/integration/default
+  - name: freebsd
+    includes:
+      - freebsd-122-latest-py3
+      - freebsd-114-latest-py3
+    provisioner:
+      state_top:
+        base:
+          '*':
+            - php._mapdata
+            - php.composer
+      pillars:
+        top.sls:
+          base:
+            '*':
+              - php
+      pillars_from_files:
+        php.sls: test/salt/pillar/freebsd.sls
+    verifier:
+      inspec_tests:
+        - path: test/integration/default

php/composer.sls

@@ -12,14 +12,9 @@
 
 include:
   - php
-{% if grains['os_family'] == 'FreeBSD' %}
-  - php.filter
-  - php.hash
-  - php.json
-  - php.mbstring
-  - php.openssl
-  - php.phar
-{% endif %}
+{%- for module in php.lookup.get('composer', {}).get('required_modules', []) %}
+  - php.{{ module }}
+{%- endfor %}
 
 get-composer:
   file.managed:

php/map.jinja

@@ -3102,6 +3102,15 @@
                 'cli': {
                     'ini': '/usr/local/etc/php.ini'
                 },
+                'composer': {
+                    'required_modules': [
+                      'filter',
+                      'json',
+                      'mbstring',
+                      'openssl',
+                      'phar',
+                    ],
+                },
                 'pkgs': {
                     'apache2': 'mod_php' + freebsd_php_version,
                     'composer_bin': 'composer',

pillar.example

@@ -74,6 +74,16 @@ php:
     cli:
       ini: /location/of/php-cli/php.ini
 
+    # php.composer
+    # Some OS need modules to be installed
+    composer:
+      required_modules:
+        - filter
+        - json
+        - mbstring
+        - openssl
+        - phar
+
   # php-fpm settings
   fpm:
 

test/integration/default/controls/config_spec.rb

@@ -29,12 +29,23 @@ def test_redhat; end
 
   def test_suse; end
 
+  def test_bsd
+    describe file('/usr/local/bin/composer') do
+      it { should be_file }
+      it { should be_owned_by 'root' }
+      it { should be_grouped_into 'wheel' }
+      its('mode') { should cmp '0755' }
+    end
+  end
+
   case os[:family]
   when 'debian'
     test_debian
   when 'redhat', 'fedora'
     test_redhat
   when 'suse'
     test_suse
+  when 'bsd'
+    test_bsd
   end
 end

test/integration/default/controls/package_spec.rb

@@ -44,12 +44,24 @@ def test_suse
     end
   end
 
+  def test_bsd
+    %w[
+      php74 php74-filter php74-json php74-mbstring php74-openssl php74-phar
+    ].each do |pkg|
+      describe package(pkg) do
+        it { should be_installed }
+      end
+    end
+  end
+
   case os[:family]
   when 'debian'
     test_debian
   when 'redhat', 'fedora'
     test_redhat
   when 'suse'
     test_suse
+  when 'bsd'
+    test_bsd
   end
 end

test/integration/default/controls/service_spec.rb

@@ -19,12 +19,16 @@ def test_redhat; end
 
   def test_suse; end
 
+  def test_bsd; end
+
   case os[:family]
   when 'debian'
     test_debian
   when 'redhat', 'fedora'
     test_redhat
   when 'suse'
     test_suse
+  when 'bsd'
+    test_bsd
   end
 end