modulorails 0.3.0 → 0.4.0

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

@@ -1,10 +1,9 @@
 version: '3.7'
 
-<% image_name = Modulorails.data.name.parameterize %>
-
+<%- image_name = Modulorails.data.name.parameterize -%>
 services:
   app:
-    image: modulotechgroup/<%=  image_name %>
+    image: modulotechgroup/<%= image_name %>
     build:
       context: .
       dockerfile: Dockerfile.prod
@@ -20,13 +19,28 @@ services:
       <%= image_name.upcase %>_DATABASE_NAME: <%= image_name %>
       RAILS_SERVE_STATIC_FILES: 'true'
 
+  <%- adapter = Modulorails.data.adapter -%>
+  <%- if adapter =~ /mysql/ -%>
   database:
-    image: mysql:8.0
+    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

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/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/{gitlabci → modulorails/gitlabci}/gitlabci_generator.rb

@@ -2,36 +2,17 @@
 
 require 'rails/generators'
 
-class GitlabciGenerator < Rails::Generators::Base
+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'
 
-  # Configurations for MySQL/Postgres dockers
-  MYSQL_DOCKER_DB = <<~EOS
-    # Install a MySQL 5.7 database and configure mandatory environment variables
-    # (https://hub.docker.com/_/mysql/)
-    services:
-      - mysql:5.7
-    variables:
-      MYSQL_DATABASE: test
-      MYSQL_ROOT_PASSWORD: password
-  EOS
-  POSTGRES_DOCKER_DB = <<~EOS
-    # Install a Postgres 11 database and configure mandatory environment variables
-    # (https://hub.docker.com/_/postgres/)
-    services:
-      - postgresql:11
-    variables:
-      POSTGRES_DB: test
-      POSTGRES_PASSWORD: password
-  EOS
-
   def create_config_file
     # Update the gitlab-ci template
     template '.gitlab-ci.yml'
 
-    # Update the database-ci template
-    template 'config/database-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

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/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

data/lib/generators/modulorails/self_update/self_update_generator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+# Author: Matthieu 'ciappa_m' Ciappara
+# This updates modulorails by editing the gemfile and running a bundle update
+class Modulorails::SelfUpdateGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+  desc 'This generator updates Modulorails if required'
+
+  LATEST_VERSION_URL = 'https://rubygems.org/api/v1/versions/modulorails/latest.json'.freeze
+
+  def create_config_file
+    modulorails_version = Gem::Version.new(Modulorails::VERSION)
+
+    # Get the last published version
+    last_published_version_s = HTTParty.get(LATEST_VERSION_URL).parsed_response['version']
+    last_published_version   = Gem::Version.new(last_published_version_s)
+
+    # Do nothing if we could not fetch the last published version (whatever the reason)
+    # Or if the current version is the same as the last published version
+    return if last_published_version <= modulorails_version
+
+    # Add gem to Gemfile
+    gsub_file 'Gemfile', /^\s*gem\s['"]modulorails['"].*$/, "gem 'modulorails', '= #{last_published_version}'"
+
+    # Update the gem and the Gemfile.lock
+    system('bundle install')
+  rescue StandardError => e
+    $stderr.puts("[Modulorails] Error: cannot generate health_check configuration: #{e.message}")
+  end
+end

data/lib/modulorails/configuration.rb

@@ -4,7 +4,7 @@ module Modulorails
   class Configuration
     # All the keys to configure the gem
     attr_accessor :_name, :_main_developer, :_project_manager, :_endpoint, :_api_key,
-                  :_no_auto_update
+                  :_no_auto_update, :_production_url, :_staging_url, :_review_base_url
 
     # This allows to define a DSL to configure the gem
     # Example:
@@ -14,8 +14,14 @@ module Modulorails
     #   config.project_manager 'pm@modulotech.fr'
     #   config.endpoint "intranet's endpoint"
     #   config.api_key "intranet's api key"
+    #   config.production_url "production.app.com"
+    #   config.staging_url "staging.app.com"
+    #   config.review_base_url "review.app.com"
     # end
-    %i[name main_developer project_manager endpoint api_key no_auto_update].each do |field|
+    %i[
+      name main_developer project_manager endpoint api_key no_auto_update production_url staging_url
+      review_base_url
+    ].each do |field|
       define_method(field) do |value=nil|
         # No value means we want to get the field
         return send("_#{field}") unless value

data/lib/modulorails/data.rb

@@ -10,7 +10,8 @@ module Modulorails
     # All the data handled by this class
     ATTRIBUTE_KEYS = %i[
       name main_developer project_manager repository type rails_name ruby_version rails_version
-      bundler_version modulorails_version adapter db_version adapter_version
+      bundler_version modulorails_version adapter db_version adapter_version production_url
+      staging_url review_base_url
     ].freeze
 
     # Useful if the gem's user need to read one of the data
@@ -30,7 +31,7 @@ module Modulorails
       # Get the gem's specifications to fetch the versions of critical gems
       loaded_specs = Gem.loaded_specs
 
-      # The three data written by the user in the configuration
+      # The data written by the user in the configuration
       # The name is the usual name of the project, the one used in conversations at Modulotech
       @name = configuration.name
       # The main developer, the lead developer, in short the developer to call when something's
@@ -39,6 +40,19 @@ module Modulorails
       # The project manager of the application; the other person to call when something's wrong with
       # the application ;)
       @project_manager = configuration.project_manager
+      # The URL of the production environment for the application
+      @production_url = configuration.production_url
+      # The URL of the staging environment for the application
+      @staging_url = configuration.staging_url
+      # The base URL of the review environment for the application.
+      # A real review URL is built like this at Modulotech:
+      # https://review-#{shortened_branch_name}-#{ci_slug}.#{review_base_url}
+      # Example:
+      # review_base_url: dev.app.com
+      # branch_name: 786-a_super_branch => shortened_branch_name: 786-a_sup
+      # ci_slug: jzzham
+      # |-> https://review-786-a_sup-jzzham.dev.app.com/
+      @review_base_url = configuration.review_base_url
 
       # Theorically, origin is the main repository of the project and git is the sole VCS we use
       # at Modulotech
@@ -101,6 +115,11 @@ module Modulorails
             'adapter'     => @adapter,
             'db_version'  => @db_version,
             'gem_version' => @adapter_version
+          },
+          'urls'                => {
+            'production'  => @production_url,
+            'staging'     => @staging_url,
+            'review_base' => @review_base_url
           }
         }
       }

data/lib/modulorails/railtie.rb

@@ -1,9 +1,24 @@
 module Modulorails
+  # Bind in the Rails lifecycle
   class Railtie < ::Rails::Railtie
-    # Binding in the Rails lifecycle. Sending data after the initialization ensures we can access
-    # all gems and symbols we might have to use.
+    # Update and add gems before we load the configuration
+    config.before_configuration do
+      # Currently, we limit everything to the development environment
+      if Rails.env.development?
+        # Check database configuration
+        Modulorails.generate_healthcheck_template
+      end
+    end
+
+    # Require the gem before we read the health_check initializer
+    config.before_initialize do
+      require 'health_check'
+    end
+
+    # Sending data after the initialization ensures we can access
+    # all gems, constants and configurations we might need.
     config.after_initialize do
-      # For now, we limit everything to the development environment
+      # Currently, we limit everything to the development environment
       if Rails.env.development?
         # Load translations
         I18n.load_path += [File.expand_path('../../../config/locales/en.yml', __FILE__)]
@@ -18,7 +33,7 @@ module Modulorails
         Modulorails.check_database_config
 
         # Gem's self-update if a new version was released
-        # Modulorails.self_update
+        Modulorails.self_update
       end
     end
   end

data/lib/modulorails/validators/database_configuration.rb

@@ -31,7 +31,7 @@ module Modulorails
 
       def call
         database_configuration = check_standard_config_file_location
-        return false unless database_configuration
+        return [:standard_config_file_location] unless database_configuration
 
         check_test_database_not_equals_dev_database(database_configuration)
         check_rules_for_environment(database_configuration, :development)

data/lib/modulorails/version.rb

@@ -1,3 +1,3 @@
 module Modulorails
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end