spectat-jekyll 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a2af09733c117d98f58c5fd80df8991958dca719da576c810588ba55e965eb1
-  data.tar.gz: 2c473294983f3136afa34635e9b39a1eb86194a7b3aac01a113e3b903812c609
+  metadata.gz: d17d33184e64289cb44daf898961cee419b6378866a8eaa7048946be871bcc90
+  data.tar.gz: 0aceb197a656bf9289cff04320bc8cc15c076fbd8a184761674f987bda04922a
 SHA512:
-  metadata.gz: 8e0f4f87b7944852b374311a57fcad730e0c2dd75109d39afe9871af93616e4500ddf23cc855affce7deb36043684722b784f80ecc90d20793a7b2291d70b170
-  data.tar.gz: 232e53aee11431a856d867ef256584235920666bf613b781c83d31b6768dd83d3c0d505fd114d406c948f65fca0b8ef61e8434cb01c3a9caff135b8057a1b937
+  metadata.gz: 88546ecefe943d90318caeaa7ed72df112eadf7a580846088bec4ba704d446b6cf4bd025f0582f27a2aa47affdccd0cff04a373e88f0594f843efb2e14f1fe15
+  data.tar.gz: e5c5c2559317d856c6e7ae24a4875fb65d9ba522cc4fcf2d9718c2b5057ba9d89013b02995b893fc980b500387fb92fa4469fc51dcb4dc3e9589cd8a431db5e5

data/.rubocop.yml

@@ -3,4 +3,6 @@ Metrics/BlockLength:
     - '*.gemspec'
     - spec/**/*.rb
 Metrics/LineLength:
-  Max: 110
+  Max: 140
+Style/RegexpLiteral:
+  EnforcedStyle: percent_r

data/lib/spectat/jekyll/rake_task.rb

@@ -0,0 +1,81 @@
+require 'spectat/jekyll/rake_task/helper'
+
+namespace :docker do
+  desc 'Build site\'s image'
+  task :build, [:full_repo_path, :image_type, :image_tag] do |_, args|
+    helper = Spectat::Jekyll::RakeTask::DockerHelper.new(args[:full_repo_path], args[:image_type].to_sym, args[:image_tag])
+    sh helper.docker_build_command
+  end
+end
+
+namespace :gitlab do
+  desc 'Generate the .gitlab-ci.yml file to a given `filename`'
+  task :generate_path, [:filename, :full_repo_path, :fqdn] do |_, args|
+    helper = Spectat::Jekyll::RakeTask::GitLabHelper.new(args[:full_repo_path], args[:fqdn])
+    File.write(args[:filename], helper.render_template)
+  end
+
+  desc 'Generate the .gitlab-ci.yml file'
+  task :generate, [:full_repo_path, :fqdn] do |_, args|
+    Rake::Task['gitlab:generate_path'].invoke('.gitlab-ci.yml', args[:full_repo_path], args[:fqdn])
+  end
+
+  desc 'Validate whether .gitlab-ci.yml has been updated'
+  task :validate, [:full_repo_path, :fqdn] do |_, args|
+    Rake::Task['gitlab:generate_path'].invoke('.gitlab-ci.new.yml', args[:full_repo_path], args[:fqdn])
+    sh 'diff -au .gitlab-ci.yml .gitlab-ci.new.yml'
+  end
+end
+
+namespace :capistrano do # rubocop:disable Metrics/BlockLength
+  namespace :capfile do
+    desc 'Generate the Capfile file to a given `filename`'
+    task :generate_path, [:filename, :full_repo_path, :fqdn] do |_, args|
+      helper = Spectat::Jekyll::RakeTask::CapistranoHelper.new(args[:full_repo_path], args[:fqdn])
+      File.write(args[:filename], helper.render_capfile)
+    end
+
+    desc 'Generate the Capfile file'
+    task :generate, [:full_repo_path, :fqdn] do |_, args|
+      Rake::Task['capistrano:capfile:generate_path'].invoke('Capfile', args[:full_repo_path], args[:fqdn])
+    end
+
+    desc 'Validate whether Capfile has been updated'
+    task :validate, [:full_repo_path, :fqdn] do |_, args|
+      Rake::Task['capistrano:capfile:generate_path'].invoke('Capfile.new', args[:full_repo_path], args[:fqdn])
+      sh 'diff -au Capfile Capfile.new'
+    end
+  end
+
+  namespace :deployrb do
+    desc 'Generate the config/deploy.rb file to a given `filename`'
+    task :generate_path, [:filename, :full_repo_path, :fqdn] do |_, args|
+      FileUtils.mkdir_p(File.dirname(args[:filename]))
+      helper = Spectat::Jekyll::RakeTask::CapistranoHelper.new(args[:full_repo_path], args[:fqdn])
+      File.write(args[:filename], helper.render_deployrb)
+    end
+
+    desc 'Generate the config/deploy.rb file'
+    task :generate, [:full_repo_path, :fqdn] do |_, args|
+      Rake::Task['capistrano:deployrb:generate_path'].invoke('config/deploy.rb', args[:full_repo_path], args[:fqdn])
+    end
+
+    desc 'Validate whether config/deploy.rb has been updated'
+    task :validate, [:full_repo_path, :fqdn] do |_, args|
+      Rake::Task['capistrano:deployrb:generate_path'].invoke('config/deploy.rb.new', args[:full_repo_path], args[:fqdn])
+      sh 'diff -au config/deploy.rb config/deploy.rb.new'
+    end
+  end
+
+  desc 'Generate Capfile and config/deploy.rb files'
+  task :generate, [:full_repo_path, :fqdn] do |_, args|
+    Rake::Task['capistrano:capfile:generate'].invoke(args[:full_repo_path], args[:fqdn])
+    Rake::Task['capistrano:deployrb:generate'].invoke(args[:full_repo_path], args[:fqdn])
+  end
+
+  desc 'Validate Capfile and config/deploy.rb are up-to-date'
+  task :generate, [:full_repo_path, :fqdn] do |_, args|
+    Rake::Task['capistrano:capfile:validate'].invoke(args[:full_repo_path], args[:fqdn])
+    Rake::Task['capistrano:deployrb:validate'].invoke(args[:full_repo_path], args[:fqdn])
+  end
+end

data/lib/spectat/jekyll/rake_task/Capfile.erb

@@ -0,0 +1 @@
+require 'spectat/jekyll/deploy'

data/lib/spectat/jekyll/rake_task/Dockerfile.builder.erb

@@ -0,0 +1,66 @@
+FROM alpine:latest
+MAINTAINER Jamie Tanna <docker@jamietanna.co.uk>
+
+# Install NodeJS and Ruby {{{
+WORKDIR "/opt/node"
+
+ENV PATH=$PATH:/opt/node/bin
+
+RUN apk update && \
+	apk upgrade && \
+	# Required to set timezone {{{
+	apk add tzdata && \
+	# }}}
+	# NodeJS {{{
+	apk add nodejs \
+		# gifsicle jpegtran-bin
+		autoconf automake file nasm && \
+	# }}}
+	# Ruby {{{
+	apk add ruby-dev ruby-bundler && \
+	apk add git \
+		build-base \
+		# for the FFI gem: https://github.com/ffi/ffi/issues/485#issuecomment-191159190
+		libffi-dev \
+		# for the nokogiri gem: https://github.com/gliderlabs/docker-alpine/issues/53#issuecomment-173412882
+		libxml2-dev libxslt-dev
+	# }}}
+# }}}
+
+# Ensure timezone is set correctly {{{
+RUN cp /usr/share/zoneinfo/Europe/London /etc/localtime
+RUN echo 'Europe/London' > /etc/timezone
+# }}}
+
+# Install package dependencies {{{
+RUN mkdir -p /app/site/_site /app/vendor/git
+WORKDIR "/app"
+
+# https://github.com/docker-library/ruby/issues/45
+ENV LANG C.UTF-8
+
+# Set /app as the initial directory for the dependencies, allowing the site to
+# then be mounted into /app/site, so we don't override any of our
+# pre-downloaded NPM dependencies {{{
+# Ensure we have the latest Node dependencies, which should be changed less
+# often than the Ruby dependencies (ie Jekyll, Capistrano) so will want to be
+# cached longer {{{
+COPY package.json /app/
+RUN npm install
+ENV PATH=$PATH:/app/node_modules/.bin
+# }}}
+# Ensure we have the latest Ruby dependencies {{{
+COPY Gemfile Gemfile.lock /app/
+COPY vendor/git/ /app/vendor/git/
+# Don't pull in deploy dependencies as they're a separate Docker image
+ENV BUNDLE_WITHOUT=deploy
+RUN bundle install
+# }}}
+# }}}
+
+# Once set up, use our mounted directory for the site
+WORKDIR "/app/site"
+
+# Default action is to serve the site {{{
+CMD ["gulp", "serve"]
+# }}}

data/lib/spectat/jekyll/rake_task/Dockerfile.built.erb

@@ -0,0 +1,3 @@
+FROM scratch
+WORKDIR /
+COPY _site /site

data/lib/spectat/jekyll/rake_task/Dockerfile.deploy.erb

@@ -0,0 +1,25 @@
+FROM alpine:latest
+MAINTAINER Jamie Tanna <docker@jamietanna.co.uk>
+
+WORKDIR "/site"
+
+RUN apk update && \
+    apk upgrade && \
+	apk add ruby-dev ruby-bundler && \
+	apk add git \
+		build-base \
+		openssh-client
+
+ADD Gemfile /site
+ADD Gemfile.lock /site
+
+RUN bundle install --without build test
+
+# Bake Capistrano config into image {{{
+# build the base file structure so we can copy into the correct directories
+RUN mkdir -p /site/config /site/lib/capistrano
+
+ADD Capfile /site
+
+ADD config/deploy.rb /site/config
+# }}}

data/lib/spectat/jekyll/rake_task/config-deploy.rb.erb

@@ -0,0 +1,2 @@
+set :application, '<%= @fqdn %>'
+set :full_repo_path, '<%= @full_repo_path %>'

data/lib/spectat/jekyll/rake_task/gitlab-ci.yml.erb

@@ -0,0 +1,199 @@
+variables:
+  CONTAINER_IMAGE_BASE_URL: registry.gitlab.com/<%= @full_repo_path %>
+  CONTAINER_BUILT_IMAGE: $CONTAINER_IMAGE_BASE_URL:$CI_COMMIT_REF_SLUG
+  CONTAINER_BUILDER_IMAGE: $CONTAINER_IMAGE_BASE_URL/builder:$CI_COMMIT_REF_SLUG
+  CONTAINER_DEPLOY_IMAGE: $CONTAINER_IMAGE_BASE_URL/deploy:$CI_COMMIT_REF_SLUG
+  RELEASE_CONTAINER_BUILT_IMAGE: $CONTAINER_IMAGE_BASE_URL:latest
+  RELEASE_CONTAINER_BUILDER_IMAGE: $CONTAINER_IMAGE_BASE_URL/builder:latest
+  RELEASE_CONTAINER_DEPLOY_IMAGE: $CONTAINER_IMAGE_BASE_URL/deploy:latest
+  DOCKER_DRIVER: overlay
+  URL_PRODUCTION: https://<%= @fqdn_production %>
+  URL_STAGING: https://<%= @fqdn_staging %>
+  URL_REVIEW_SUFFIX: <%= @fqdn_suffix_review %>
+
+stages:
+  - build
+  - test
+  - review
+  - staging
+  - release
+  - production
+
+# Ensure that the site builds {{{
+build_image:
+  image: docker:1.13
+  services:
+    - docker:1.13-dind
+  stage: build
+  script:
+    # Grab the private submodules (public are fine) {{{
+    - apk --update add openssh-client git
+    - .ci/ssh-init.sh
+    - eval $(ssh-agent -s) && echo "$RO_CLONE_PRIVATE_KEY" | ssh-add -
+    - git submodule update --init
+    # }}}
+
+    - docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY
+    # pull the latest base image on a master build
+    - docker pull $CONTAINER_BUILDER_IMAGE || docker pull $RELEASE_CONTAINER_BUILDER_IMAGE || true
+    # Build the builder image {{{
+    - bundle exec rake "docker:build[<%= @full_repo_path %>,builder,$CI_COMMIT_REF_SLUG]"
+    - docker push $CONTAINER_BUILDER_IMAGE
+    # }}}
+    # Build the built image {{{
+    - docker run -v $(readlink -f .):/app/site $CONTAINER_BUILDER_IMAGE gulp build --production
+    - bundle exec rake "docker:build[<%= @full_repo_path %>,built,$CI_COMMIT_REF_SLUG]"
+    - docker push $CONTAINER_BUILT_IMAGE
+    # }}}
+    # Build the deploy image {{{
+    - docker pull $CONTAINER_DEPLOY_IMAGE || docker pull $RELEASE_CONTAINER_DEPLOY_IMAGE || true
+    - bundle exec rake "docker:build[<%= @full_repo_path %>,deploy,$CI_COMMIT_REF_SLUG]"
+    - docker push $CONTAINER_DEPLOY_IMAGE
+    # }}}
+# }}}
+
+test:
+  image: $CONTAINER_BUILDER_IMAGE
+  stage: test
+  script:
+    - bundle exec rake 'capistrano:validate[<%= @full_repo_path %>,<%= @fqdn_production %>]'
+    - bundle exec rake 'gitlab:validate[<%= @full_repo_path %>,<%= @fqdn_production %>]'
+
+# Review Apps {{{
+review_deploy:
+  image: $CONTAINER_DEPLOY_IMAGE
+  stage: review
+  script:
+    # ensure we're in the directory with our capistrano configuration
+    - cd /site
+    # ensure that deployments can use the SSH key that is passed in via the
+    # environment variables. Via https://docs.gitlab.com/ce/ci/ssh_keys/README.html
+    - eval $(ssh-agent -s)
+      # add ssh key stored in SSH_PRIVATE_KEY variable to the agent store
+    - echo -e "$REVIEW_SSH_PRIVATE_KEY" | ssh-add -
+    - cap review deploy
+  environment:
+    name: review/$CI_COMMIT_REF_SLUG
+    url: https://$CI_COMMIT_REF_SLUG.$URL_REVIEW_SUFFIX
+    on_stop: review_stop
+  only:
+    - branches
+  variables:
+    GIT_STRATEGY: none
+  except:
+    - master
+
+review_stop:
+  image: $CONTAINER_DEPLOY_IMAGE
+  stage: review
+  script:
+    # ensure we're in the directory with our capistrano configuration
+    - cd /site
+    # ensure that deployments can use the SSH key that is passed in via the
+    # environment variables. Via https://docs.gitlab.com/ce/ci/ssh_keys/README.html
+    - eval $(ssh-agent -s)
+      # add ssh key stored in SSH_PRIVATE_KEY variable to the agent store
+    - echo -e "$REVIEW_SSH_PRIVATE_KEY" | ssh-add -
+    - cap review stop
+  environment:
+    name: review/$CI_COMMIT_REF_SLUG
+    action: stop
+  variables:
+    GIT_STRATEGY: none
+  when: manual
+  only:
+    - branches
+  except:
+    - master
+# }}}
+
+# Staging {{{
+staging_deploy:
+  image: $CONTAINER_DEPLOY_IMAGE
+  stage: staging
+  script:
+    # ensure we're in the directory with our capistrano configuration
+    - cd /site
+    # ensure that deployments can use the SSH key that is passed in via the
+    # environment variables. Via https://docs.gitlab.com/ce/ci/ssh_keys/README.html
+    - eval $(ssh-agent -s)
+      # add ssh key stored in SSH_PRIVATE_KEY variable to the agent store
+    - echo -e "$STAGING_SSH_PRIVATE_KEY" | ssh-add -
+    - cap staging deploy
+  environment:
+    name: staging
+    url: $URL_STAGING
+  variables:
+    GIT_STRATEGY: none
+  only:
+    - master
+# }}}
+
+# Push the images up to the registry as our :latest image, on master {{{
+release_builder_image:
+  image: docker:1.13
+  services:
+    - docker:1.13-dind
+  stage: release
+  script:
+    - docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY
+    - docker pull "$CONTAINER_BUILDER_IMAGE"
+    - docker tag "$CONTAINER_BUILDER_IMAGE" "$RELEASE_CONTAINER_BUILDER_IMAGE"
+    - docker push "$RELEASE_CONTAINER_BUILDER_IMAGE"
+  variables:
+    GIT_STRATEGY: none
+  only:
+    - master
+
+release_built_image:
+  image: docker:1.13
+  services:
+    - docker:1.13-dind
+  stage: release
+  script:
+    - docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY
+    - docker pull "$CONTAINER_BUILT_IMAGE"
+    - docker tag "$CONTAINER_BUILT_IMAGE" "$RELEASE_CONTAINER_BUILT_IMAGE"
+    - docker push "$RELEASE_CONTAINER_BUILT_IMAGE"
+  variables:
+    GIT_STRATEGY: none
+  only:
+    - master
+
+release_deploy_image:
+  image: docker:1.13
+  services:
+    - docker:1.13-dind
+  stage: release
+  script:
+    - docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY
+    - docker pull "$CONTAINER_DEPLOY_IMAGE"
+    - docker tag "$CONTAINER_DEPLOY_IMAGE" "$RELEASE_CONTAINER_DEPLOY_IMAGE"
+    - docker push "$RELEASE_CONTAINER_DEPLOY_IMAGE"
+  variables:
+    GIT_STRATEGY: none
+  only:
+    - master
+# }}}
+
+# Production {{{
+prod_deploy:
+  image: $CONTAINER_DEPLOY_IMAGE
+  stage: production
+  script:
+    # ensure we're in the directory with our capistrano configuration
+    - cd /site
+    # ensure that deployments can use the SSH key that is passed in via the
+    # environment variables. Via https://docs.gitlab.com/ce/ci/ssh_keys/README.html
+    - eval $(ssh-agent -s)
+      # add ssh key stored in SSH_PRIVATE_KEY variable to the agent store
+    - echo -e "$PRODUCTION_SSH_PRIVATE_KEY" | ssh-add -
+    - cap production deploy
+  environment:
+    name: production
+    url: $URL_PRODUCTION
+  variables:
+    GIT_STRATEGY: none
+  only:
+    - master
+# }}}

data/lib/spectat/jekyll/rake_task/helper.rb

@@ -0,0 +1,97 @@
+require 'erubis'
+require 'spectat/fqdn'
+
+module Spectat
+  module Jekyll
+    module RakeTask
+      # Helper class for standardising Docker configuration
+      class DockerHelper
+        attr_reader :full_repo_path
+        attr_reader :image_type
+        attr_reader :image_tag
+
+        VALID_IMAGE_TYPES = %i[builder built deploy].freeze
+
+        def initialize(full_repo_path, image_type, image_tag)
+          raise ArgumentError, 'image_type must be ' + VALID_IMAGE_TYPES.to_s unless VALID_IMAGE_TYPES.include?(image_type)
+
+          @full_repo_path = full_repo_path
+          @image_type = image_type
+          @image_tag = image_tag
+          @image_name = case @image_type
+                        when :built
+                          ''
+                        else
+                          "/#{@image_type}"
+                        end
+        end
+
+        def image_path
+          "registry.gitlab.com/#{@full_repo_path}#{@image_name}:#{@image_tag}"
+        end
+
+        def docker_build_command
+          "docker build --pull --cache-from #{image_path} --tag #{image_path} --file #{path_to_dockerfile(__FILE__)} ."
+        end
+
+        def path_to_dockerfile(executing_script_path)
+          dockerfile = "Dockerfile.#{@image_type}.erb"
+          full_path = File.join(File.dirname(executing_script_path), dockerfile)
+          raise IOError, "#{full_path} doesn't exist" unless File.file?(full_path)
+          full_path
+        end
+      end
+
+      # Helper class for generating standardised GitLab CI configuration
+      class GitLabHelper
+        attr_reader :fqdn
+        attr_reader :full_repo_path
+
+        def initialize(full_repo_path, fqdn)
+          @full_repo_path = full_repo_path
+          @fqdn = fqdn
+        end
+
+        def render_template
+          template = File.read(File.join(File.dirname(__FILE__), 'gitlab-ci.yml.erb'))
+          erb = Erubis::Eruby.new(template)
+
+          staging_helper = Spectat::Fqdn.new(@fqdn, 'staging')
+          review_helper = Spectat::Fqdn.new(staging_helper.review_apps_fqdn, 'staging')
+
+          erb.evaluate(
+            fqdn_production: Spectat::Fqdn.new(@fqdn, 'production').fqdn,
+            fqdn_staging: staging_helper.fqdn,
+            fqdn_suffix_review: review_helper.fqdn,
+            full_repo_path: @full_repo_path
+          )
+        end
+      end
+
+      # Helper class for generating standardised Capistrano configuration
+      class CapistranoHelper
+        attr_reader :fqdn
+        attr_reader :full_repo_path
+
+        def initialize(full_repo_path, fqdn)
+          @full_repo_path = full_repo_path
+          @fqdn = fqdn
+        end
+
+        def render_capfile
+          File.read(File.join(File.dirname(__FILE__), 'Capfile.erb'))
+        end
+
+        def render_deployrb
+          template = File.read(File.join(File.dirname(__FILE__), 'config-deploy.rb.erb'))
+          erb = Erubis::Eruby.new(template)
+
+          erb.evaluate(
+            fqdn: @fqdn,
+            full_repo_path: @full_repo_path
+          )
+        end
+      end
+    end
+  end
+end

data/lib/spectat/jekyll/version.rb

@@ -1,5 +1,5 @@
 module Spectat
   module Jekyll
-    VERSION = '0.1.3'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

data/spectat-jekyll.gemspec

@@ -35,6 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '~> 0.55.0'
 
   spec.add_runtime_dependency 'capistrano', '~> 3.7.1'
+  spec.add_runtime_dependency 'erubis'
   spec.add_runtime_dependency 'jekyll', '~> 3.7.3'
   # https://github.com/jekyll/jekyll/issues/4838
   spec.add_runtime_dependency 'json'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spectat-jekyll
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Jamie Tanna
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-08 00:00:00.000000000 Z
+date: 2018-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.7.1
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +159,14 @@ files:
 - lib/spectat/jekyll/deploy/stages/staging.rb
 - lib/spectat/jekyll/deploy/tasks/deploy.rake
 - lib/spectat/jekyll/deploy/tasks/review.rake
+- lib/spectat/jekyll/rake_task.rb
+- lib/spectat/jekyll/rake_task/Capfile.erb
+- lib/spectat/jekyll/rake_task/Dockerfile.builder.erb
+- lib/spectat/jekyll/rake_task/Dockerfile.built.erb
+- lib/spectat/jekyll/rake_task/Dockerfile.deploy.erb
+- lib/spectat/jekyll/rake_task/config-deploy.rb.erb
+- lib/spectat/jekyll/rake_task/gitlab-ci.yml.erb
+- lib/spectat/jekyll/rake_task/helper.rb
 - lib/spectat/jekyll/version.rb
 - spectat-jekyll.gemspec
 homepage: https://gitlab.com/spectat/gems/spectat-jekyll-gem