modulorails 0.2.2 → 1.0.1

data/entrypoints/appraisal_test.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+# Exit immediately if a command exits with a non-zero status
+set -e
+
+# Launch the tests
+bundle exec appraisal rake spec

data/gemfiles/rails_52.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "rails", "~> 5.2", ">= 5.2.6"
+
+gemspec path: "../"

data/gemfiles/rails_60.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "rails", "~> 6.0", ">= 6.0.4.4"
+
+gemspec path: "../"

data/gemfiles/rails_61.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "rails", "~> 6.1", ">= 6.1.4.4"
+
+gemspec path: "../"

data/gemfiles/rails_70.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "rails", "~> 7.0"
+
+gemspec path: "../"

data/lib/generators/modulorails/docker/docker_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+class Modulorails::DockerGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+  desc 'This generator creates Dockerfiles for an app'
+
+  def create_config_file
+    template 'Dockerfile'
+    template 'Dockerfile.prod'
+    template 'docker-compose.yml'
+    template 'docker-compose.prod.yml'
+    template 'entrypoints/docker-entrypoint.sh'
+    template 'config/database.yml'
+  rescue StandardError => e
+    $stderr.puts("[Modulorails] Error: cannot generate Docker configuration: #{e.message}")
+  end
+end

data/lib/generators/modulorails/docker/templates/Dockerfile.prod.tt

@@ -0,0 +1,57 @@
+# BUILD IMAGE
+FROM ruby:<%= Modulorails.data.ruby_version %>-alpine as builder
+
+ENV RAILS_ENV=production
+WORKDIR /app
+
+RUN apk add --update --no-cache \
+    alpine-sdk \
+    nodejs \
+    tzdata \
+    yarn \
+    shared-mime-info \
+    <%- adapter = Modulorails.data.adapter -%>
+    <%- if adapter =~ /mysql/ -%>
+    mysql-dev
+    <%- else -%>
+    postgresql-dev
+    <%- end -%>
+RUN gem install bundler -v <%= Modulorails.data.bundler_version %>
+
+COPY Gemfile Gemfile.lock ./
+RUN bundle check || bundle install --deployment --jobs=2 \
+    && rm -rf vendor/bundle/ruby/*/cache/*
+
+COPY package.json yarn.lock ./
+RUN yarn install
+
+COPY . .
+RUN bundle exec rake assets:precompile
+
+# FINAL IMAGE
+FROM ruby:<%= Modulorails.data.ruby_version %>-alpine
+
+WORKDIR /app
+
+RUN apk add --update --no-cache \
+    curl \
+    git \
+    nodejs \
+    tzdata \
+    shared-mime-info \
+    <%- adapter = Modulorails.data.adapter -%>
+    <%- if adapter =~ /mysql/ -%>
+    mysql-dev \
+    <%- else -%>
+    postgresql-dev \
+    <%- end -%>
+    && rm -rf .git/
+
+COPY --from=builder /app .
+
+RUN bundle config --local path vendor/bundle \
+    && bundle config --local without development:test:assets
+
+EXPOSE 3000
+
+ENTRYPOINT ["./entrypoints/docker-entrypoint.sh"]

data/lib/generators/modulorails/docker/templates/Dockerfile.tt

@@ -0,0 +1,26 @@
+FROM ruby:<%= Modulorails.data.ruby_version %>-alpine
+
+ENV RAILS_ENV=development
+WORKDIR /app
+
+RUN apk add --update --no-cache \
+    alpine-sdk \
+    nodejs \
+    yarn \
+    tzdata \
+    <%- adapter = Modulorails.data.adapter -%>
+    <%- if adapter =~ /mysql/ -%>
+    mysql-dev
+    <%- else -%>
+    postgresql-dev
+    <%- end -%>
+RUN gem install bundler -v <%= Modulorails.data.bundler_version %>
+
+COPY Gemfile Gemfile.lock ./
+RUN bundle install --jobs=2
+
+COPY . .
+
+EXPOSE 3000
+
+ENTRYPOINT ["./entrypoints/docker-entrypoint.sh"]

data/lib/generators/modulorails/docker/templates/config/database.yml.tt

@@ -0,0 +1,32 @@
+<%- image_name = Modulorails.data.name.parameterize -%>
+<%- upper_image_name = image_name.upcase -%>
+<%- adapter = Modulorails.data.adapter -%>
+<%- if adapter =~ /mysql/ -%>
+development: &default
+  adapter: mysql2
+  encoding: utf8mb4
+  collation: utf8mb4_unicode_ci
+  database: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_NAME', '<%= image_name %>') %>
+  username: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_USERNAME', 'root') %>
+  password: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_PASSWORD', '') %>
+  host: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_HOST', 'database') %>
+  port: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_PORT', 3306) %>
+<%- else -%>
+development: &default
+  adapter: pg
+  database: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_NAME', '<%= image_name %>') %>
+  username: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_USERNAME', 'postgres') %>
+  password: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_PASSWORD', 'postgres') %>
+  host: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_HOST', 'database') %>
+  port: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_PORT', 5432) %>
+<%- end -%>
+
+test:
+  <<: *default
+  database: <%%= ENV.fetch('<%= upper_image_name %>_TEST_DATABASE_NAME', '<%= image_name %>_test') %>
+
+staging:
+  <<: *default
+
+production:
+  <<: *default

data/lib/generators/modulorails/docker/templates/docker-compose.prod.yml.tt

@@ -0,0 +1,50 @@
+version: '3.7'
+
+<%- image_name = Modulorails.data.name.parameterize -%>
+services:
+  app:
+    image: modulotechgroup/<%= image_name %>
+    build:
+      context: .
+      dockerfile: Dockerfile.prod
+    depends_on:
+      - database
+      - redis
+    ports:
+      - '3000:3000'
+    environment:
+      RAILS_ENV: production
+      URL: http://localhost:3000
+      <%= image_name.upcase %>_DATABASE_HOST: database
+      <%= image_name.upcase %>_DATABASE_NAME: <%= image_name %>
+      RAILS_SERVE_STATIC_FILES: 'true'
+
+  <%- adapter = Modulorails.data.adapter -%>
+  <%- if adapter =~ /mysql/ -%>
+  database:
+    image: mysql/mysql-server:8.0
+    volumes:
+      - db_data:/var/lib/mysql
+    environment:
+      MYSQL_ALLOW_EMPTY_PASSWORD: 'true'
+      MYSQL_DATABASE: <%= image_name %>
+      MYSQL_ROOT_HOST: '%'
+  <%- else -%>
+  database:
+    image: postgres:13.5
+    volumes:
+      - db_data:/var/lib/postgresql/data
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: <%= image_name %>
+      LC_COLLATE: 'en_US.UTF-8'
+      LC_CTYPE: 'en_US.UTF-8'
+  <%- end -%>
+
+  redis:
+    image: redis:6.2-alpine
+
+# Define the volumes references in the services
+volumes:
+  db_data:

data/lib/generators/modulorails/docker/templates/docker-compose.yml.tt

@@ -0,0 +1,71 @@
+version: '3.7'
+
+<%- image_name = Modulorails.data.name.parameterize -%>
+services:
+  app:
+    image: modulotechgroup/<%= image_name %>:dev
+    build:
+      context: .
+      dockerfile: Dockerfile
+    depends_on:
+      - database
+      - redis
+    ports:
+      - '3000:3000'
+    volumes:
+      - .:/app
+    environment:
+      RAILS_ENV: development
+      URL: http://localhost:3000
+      <%= image_name.upcase %>_DATABASE_HOST: database
+      <%= image_name.upcase %>_DATABASE_NAME: <%= image_name %>
+    entrypoint: ./entrypoints/docker-entrypoint.sh
+
+  <%- adapter = Modulorails.data.adapter -%>
+  <%- if adapter =~ /mysql/ -%>
+  database:
+    image: mysql/mysql-server:8.0
+    volumes:
+      - db_data:/var/lib/mysql
+    environment:
+      MYSQL_ALLOW_EMPTY_PASSWORD: 'true'
+      MYSQL_DATABASE: <%= image_name %>
+      MYSQL_ROOT_HOST: '%'
+  <%- else-%>
+  database:
+    image: postgres:13.5
+    volumes:
+      - db_data:/var/lib/postgresql/data
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: <%= image_name %>
+      LC_COLLATE: 'en_US.UTF-8'
+      LC_CTYPE: 'en_US.UTF-8'
+  <%- end-%>
+
+  redis:
+    image: redis:6.2-alpine
+
+  mailcatcher:
+    image: tophfr/mailcatcher
+    ports:
+      - 1080:80
+
+ webpack:
+   image: modulotechgroup/<%= image_name %>:dev
+   build:
+     context: .
+     dockerfile: Dockerfile
+   entrypoint: ./entrypoints/webpack-entrypoint.sh
+   volumes:
+     - .:/app
+   ports:
+     - '3035:3035'
+   environment:
+     NODE_ENV: development
+     RAILS_ENV: development
+     WEBPACKER_DEV_SERVER_HOST: 0.0.0.0
+
+volumes:
+  db_data:

data/lib/generators/modulorails/docker/templates/entrypoints/docker-entrypoint.sh.tt

@@ -0,0 +1,20 @@
+#!/bin/sh
+
+# Exit immediately if a command exits with a non-zero status
+set -e
+
+# No `node_modules` directory means `yarn install` was never launched.
+# It is mandatory to install yarn dependencies.
+if [ ! -d node_modules ]
+then
+  yarn install
+fi
+
+# Remove pidfile if it exists else the server will not launch
+if [ -f tmp/pids/server.pid ]
+then
+  rm tmp/pids/server.pid
+fi
+
+# Launch the application listening from all origins on port 3000
+./bin/bundle exec rails s -b 0.0.0.0 -p 3000

data/lib/generators/modulorails/docker/templates/entrypoints/webpack-entrypoint.sh.tt

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+# Exit immediately if a command exits with a non-zero status
+set -e
+
+# Launch webpack
+./bin/webpack-dev-server

data/lib/generators/modulorails/gitlabci/gitlabci_generator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+class Modulorails::GitlabciGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+  desc 'This generator creates a template for a .gitlab-ci.yml file at root'
+
+  def create_config_file
+    # Update the gitlab-ci template
+    template '.gitlab-ci.yml'
+
+    # Remove the database-ci template if it exists.
+    # It used to be referenced by the gitlab-ci template.
+    remove_file 'config/database-ci.yml'
+
+    # Create file to avoid this generator on next modulorails launch
+    create_keep_file
+  rescue StandardError => e
+    $stderr.puts("[Modulorails] Error: cannot generate CI configuration: #{e.message}")
+  end
+
+  private
+
+  def create_keep_file
+    file = '.modulorails-gitlab-ci'
+
+    # Create file to avoid this generator on next modulorails launch
+    copy_file(file, file)
+
+    say "Add #{file} to git"
+    %x(git add #{file})
+  end
+end

data/lib/generators/modulorails/gitlabci/templates/.gitlab-ci.yml.tt

@@ -0,0 +1,118 @@
+<%- image_name = Modulorails.data.name.parameterize -%>
+include:
+  - project: 'modulosource/modulotech/devops/gitlab-ci-templates'
+    file:
+      - '/templates/helm.gitlab-ci.yml'
+      - '/templates/integration.gitlab-ci.yml'
+      - '/templates/docker-buildx.gitlab-ci.yml'
+
+services:
+  <%- adapter = Modulorails.data.adapter -%>
+  <%- if adapter =~ /mysql/ -%>
+  - mysql:8.0
+  <%- else -%>
+  - postgres:13.5
+  <%- end -%>
+  - redis:6.2
+
+variables:
+  IMAGE_NAME: <%= image_name %>
+  MYSQL_DATABASE: <%= image_name %>_test
+  MYSQL_ALLOW_EMPTY_PASSWORD: 'true'
+  <%= image_name.upcase %>_DATABASE_HOST: mysql
+
+stages:
+  - test
+  - build
+  - deploy
+
+test:
+  extends: .test
+  script:
+    - "bundle exec rake db:create RAILS_ENV=test"
+    - "RAILS_ENV=test bundle exec rake db:migrate:reset"
+    - RAILS_ENV=test bundle exec rspec --format progress --format RspecJunitFormatter --out rspec.xml
+
+build_integration_image:
+  extends: .build_integration_image
+
+docker_build:
+  extends: .docker_buildx_push
+  only:
+    - merge_requests
+    - staging
+
+<%- review_base_url = Modulorails.data.review_base_url -%>
+<%- if review_base_url.present? -%>
+deploy_review:
+  extends: .deploy_helm
+  variables:
+    NAMESPACE: <%= image_name %>-$CI_ENVIRONMENT_SLUG
+    NAME: <%= image_name %>
+    CHART_NAME: <%= image_name %>
+    CONFIG_FILE: config/deploy/kubernetes/review.yaml
+    EXTRA_VARS: --set image.tag=$CI_COMMIT_SHORT_SHA --set ingress.hosts[0].host=${CI_ENVIRONMENT_SLUG}.<%= review_base_url %> --set ingress.tls[0].hosts[0]=${CI_ENVIRONMENT_SLUG}.<%= review_base_url %> --set env.url=${CI_ENVIRONMENT_SLUG}.<%= review_base_url %> --set database.password=$DB_PASSWORD --set encryption.key=$ENCRYPTION_KEY
+  environment:
+    name: review/$CI_COMMIT_REF_SLUG
+    url: https://${CI_ENVIRONMENT_SLUG}.<%= review_base_url %>
+    on_stop: stop_review
+    auto_stop_in: 3 days
+  only:
+    - merge_requests
+
+stop_review:
+  extends: .stop_review
+  variables:
+    NAMESPACE: <%= image_name %>-$CI_ENVIRONMENT_SLUG
+    NAME: <%= image_name %>
+  only:
+    - merge_requests
+<%- end -%>
+
+<%- staging_url = Modulorails.data.staging_url -%>
+<%- if staging_url.present? -%>
+deploy_staging:
+  extends: .deploy_helm
+  variables:
+    NAMESPACE: <%= image_name %>
+    NAME: <%= image_name %>
+    CHART_NAME: <%= image_name %>
+    CONFIG_FILE: config/deploy/kubernetes/staging.yaml
+    EXTRA_VARS: --set image.tag=$CI_COMMIT_SHORT_SHA --set database.password=$DB_PASSWORD
+  environment:
+    name: staging
+    url: https://<%= staging_url %>
+  only:
+    - staging
+<%- else -%>
+deploy_staging:
+  extends: .deploy_capistrano
+  variables:
+    STAGE: staging
+  only:
+    - staging
+<%- end -%>
+
+<%- production_url = Modulorails.data.production_url -%>
+<%- if production_url.present? -%>
+deploy_production:
+  extends: .deploy_helm
+  variables:
+    NAMESPACE: <%= image_name %>
+    NAME: <%= image_name %>
+    CHART_NAME: <%= image_name %>
+    CONFIG_FILE: config/deploy/kubernetes/production.yaml
+    EXTRA_VARS: --set image.tag=$CI_COMMIT_SHORT_SHA --set database.password=$DB_PASSWORD
+  environment:
+    name: production
+    url: https://<%= production_url %>
+  only:
+    - master
+<%- else -%>
+deploy_production:
+  extends: .deploy_capistrano
+  variables:
+    STAGE: production
+  only:
+    - master
+<%- end -%>

data/lib/generators/modulorails/gitlabci/templates/.modulorails-gitlab-ci

@@ -0,0 +1,6 @@
+This file ensures the modulorails gem will not try to override your current .gitlab-ci.yml
+file on Rails start.
+
+If you want to reset your CI configuration, you can either:
+- remove this file,
+- or run `rails g modulorails:gitlabci`.

data/lib/generators/modulorails/gitlabci/templates/config/database-ci.yml.tt

@@ -0,0 +1,8 @@
+<%- adapter = Modulorails.data.adapter -%>
+test:
+  host: <%= adapter =~ /mysql/ ? 'mysql' : 'postgres' %>
+  adapter: <%= adapter %>
+  database: test
+  username: root
+  password: password
+  encoding: utf8

data/lib/generators/modulorails/healthcheck/health_check_generator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+class Modulorails::HealthCheckGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+  desc 'This generator creates a configuration for the health_check gem'
+
+  def create_config_file
+    # Update the template
+    template 'config/initializers/health_check.rb'
+
+    # Add the route
+    unless File.read(Rails.root.join('config/routes.rb')).match?('health_check_routes')
+      inject_into_file 'config/routes.rb', after: "Rails.application.routes.draw do\n" do <<~'RUBY'
+        health_check_routes
+      RUBY
+      end
+    end
+
+    # Update the gem and the Gemfile.lock
+    system('bundle install')
+
+    # Create file to avoid this generator on next modulorails launch
+    create_keep_file
+  rescue StandardError => e
+    $stderr.puts("[Modulorails] Error: cannot generate health_check configuration: #{e.message}")
+  end
+
+  private
+
+  def create_keep_file
+    file = '.modulorails-health_check'
+
+    # Create file to avoid this generator on next modulorails launch
+    copy_file(file, file)
+
+    say "Add #{file} to git"
+    %x(git add #{file})
+  end
+end

data/lib/generators/modulorails/healthcheck/templates/.modulorails-health_check

@@ -0,0 +1,6 @@
+This file ensures the modulorails gem will not try to override your current
+config/initializers/health_check.rb file on Rails start.
+
+If you want to reset your heal_check configuration, you can either:
+- remove this file,
+- or run `rails g modulorails:health_check`.

data/lib/generators/modulorails/healthcheck/templates/config/initializers/health_check.rb.tt

@@ -0,0 +1,100 @@
+HealthCheck.setup do |config|
+
+  # uri prefix (no leading slash)
+  config.uri = 'health'
+
+  # Text output upon success
+  config.success = 'success'
+
+  # Text output upon failure
+  config.failure = 'health_check failed'
+
+  # Disable the error message to prevent /health_check from leaking
+  # sensitive information
+  config.include_error_in_response_body = false
+
+  # Log level (success or failure message with error details is sent to rails log unless this is set to nil)
+  config.log_level = 'info'
+
+  # Timeout in seconds used when checking smtp server
+  config.smtp_timeout = 30.0
+
+  # http status code used when plain text error message is output
+  # Set to 200 if you want your want to distinguish between partial (text does not include success) and
+  # total failure of rails application (http status of 500 etc)
+
+  config.http_status_for_error_text = 500
+
+  # http status code used when an error object is output (json or xml)
+  # Set to 200 if you want to distinguish between partial (healthy property == false) and
+  # total failure of rails application (http status of 500 etc)
+
+  config.http_status_for_error_object = 500
+
+  # bucket names to test connectivity - required only if s3 check used, access permissions can be mixed
+  # config.buckets = { 'bucket_name' => %i[R W D] }
+
+  # You can customize which checks happen on a standard health check, eg to set an explicit list use:
+  config.standard_checks = %w[database migrations custom]
+
+  # Or to exclude one check:
+  config.standard_checks -= %w[emailconf]
+
+  # You can set what tests are run with the 'full' or 'all' parameter
+  config.full_checks = %w[database migrations custom email cache redis]
+  # config.full_checks = %w[database migrations custom email cache redis sidekiq-redis s3]
+
+  # Add one or more custom checks that return a blank string if ok, or an error message if there is an error
+  # config.add_custom_check do
+  #   CustomHealthCheck.perform_check # any code that returns blank on success and non blank string upon failure
+  # end
+
+  # Add another custom check with a name, so you can call just specific custom checks. This can also be run using
+  # the standard 'custom' check.
+  # You can define multiple tests under the same name - they will be run one after the other.
+  # config.add_custom_check('sometest') do
+  #   CustomHealthCheck.perform_another_check # any code that returns blank on success and non blank string upon failure
+  # end
+
+  # max-age of response in seconds
+  # cache-control is public when max_age > 1 and basic_auth_username is not set
+  # You can force private without authentication for longer max_age by
+  # setting basic_auth_username but not basic_auth_password
+  config.max_age = 1
+
+  # Protect health endpoints with basic auth
+  # These default to nil and the endpoint is not protected
+  # config.basic_auth_username = 'my_username'
+  # config.basic_auth_password = 'my_password'
+
+  # Whitelist requesting IPs by a list of IP and/or CIDR ranges, either IPv4 or IPv6 (uses IPAddr.include? method to check)
+  # Defaults to blank which allows any IP
+  # config.origin_ip_whitelist = %w(123.123.123.123 10.11.12.0/24 2400:cb00::/32)
+
+  # Use ActionDispatch::Request's remote_ip method when behind a proxy to pick up the real remote IP for origin_ip_whitelist check
+  # Otherwise uses Rack::Request's ip method (the default, and always used by Middleware), which is more susceptible to spoofing
+  # See https://stackoverflow.com/questions/10997005/whats-the-difference-between-request-remote-ip-and-request-ip-in-rails
+  config.accept_proxied_requests = false
+
+  # http status code used when the ip is not allowed for the request
+  config.http_status_for_ip_whitelist_error = 403
+
+  # rabbitmq
+  # config.rabbitmq_config = {}
+
+  # When redis url/password is non-standard
+  config.redis_url = ENV['REDIS_URL']
+  # Only included if set, as url can optionally include passwords as well
+  # config.redis_password = 'redis_password' # default ENV['REDIS_PASSWORD']
+
+  # Failure Hooks to do something more ...
+  # checks lists the checks requested
+  config.on_failure do |checks, msg|
+    # log msg somewhere
+  end
+
+  config.on_success do |checks|
+    # flag that everything is well
+  end
+
+end