modulorails 1.2.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47ac5a151c8230d9ff0e9b775d32bd2a27eddbea284cf30aacf0bc863eb65a47
-  data.tar.gz: 180b663722790df15a3e180fbfe32a13f8743a57e28f6d74005d93ee08bf98b0
+  metadata.gz: 6a06133e9c157d574ab3cc83ffd931e7e61873d7c8deff63c22b8a0657def075
+  data.tar.gz: d345aa7aa32575496041762e43f198001260a003dc811c69ae704f889dde0411
 SHA512:
-  metadata.gz: a90d84b0c21e644e07d097e6c00b77af37dbfe1d43b1e1b4f75fd614fc7bc87bf86a93343e1362ab78a4321f1f1081bad4e3605a7c10dee082ab31cc346d102d
-  data.tar.gz: 9bcdf33285526a1ecca9dee4b05ab6d5f343280f8e9ec34427e428ab52786a11ab3235cf5ed77c5a1eb59163ff1dfb54d905c280068cf0f10032e47379c3c0e6
+  metadata.gz: 1594ae1f801bf28f08ec2a86ecc6040f48c513d2c47a2dfb9f0a8a3b69bf2dd7f04d6465aff1041faf80759fb70610ff57a8b02b83bddf4cbdc3ab9c553bdb9b
+  data.tar.gz: 4e4652c68c1ba65d1ce429c5acffbb5e11c8f82effdcdd55735d91cb8c12e442f6a00b5b5099a316b26f8620ef20873c96b5349df4ea58ec24566aaebe75abb1

data/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 This file is used to list changes made in each version of the gem.
 
+# 1.3.1
+
+- Update templates according to new devops standards:
+  - Add exec commands in entrypoints.
+  - Upgrade PG and Redis version in docker-compose files.
+  - Upgrade PG and Redis version in test stage in CI.
+  - Add default SECRET_KEY_BASE and optional `yarn install` in `Dockerfile.prod` templates.
+  - Add templates for Kubernetes values files.
+  - Append sidekiq in Kubernetes values files in Sidekiq generator.
+
+# 1.3.0
+
+- Update redis configuration in generators.
+- Update mailcatcher docker image for better compatibility with ARM64.
+- Remove possible suffix `Service` in service generator.
+- Update rubocop configuration in template.
+- Add a generator to add Sidekiq to a project.
+- Update docker generator to use valid names for environment variables.
+
 # 1.2.1
 
 - Update rubocop configuration.

data/README.md

@@ -28,6 +28,9 @@ Modulorails.configure do |config|
   config.project_manager 'The email of the project manager of the application'
   config.endpoint 'The url to the intranet'
   config.api_key 'The API key'
+  config.review_base_url 'The base url for the review environments' # optional
+  config.staging_url 'The url for the staging environment'          # optional
+  config.production_url 'The url for the production environment'    # optional
 end
 ``` 
 

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

@@ -8,6 +8,12 @@ class Modulorails::DockerGenerator < Rails::Generators::Base
   desc 'This generator creates Dockerfiles for an app'
 
   def create_config_file
+    @data = Modulorails.data
+    @adapter = data.adapter
+    @webpack_container_needed = data.webpacker_version.present?
+    @image_name = @data.name.parameterize
+    @environment_name = @data.environment_name
+
     template 'Dockerfile'
     template 'Dockerfile.prod'
     template 'docker-compose.yml'
@@ -15,9 +21,10 @@ class Modulorails::DockerGenerator < Rails::Generators::Base
     template 'entrypoints/docker-entrypoint.sh'
     chmod 'entrypoints/docker-entrypoint.sh', 0755
     template 'config/database.yml'
+    template 'config/cable.yml'
 
     # Useless unless project is using Webpacker
-    if Modulorails.data.webpacker_version.present?
+    if @webpack_container_needed
       template 'entrypoints/webpack-entrypoint.sh'
       chmod 'entrypoints/webpack-entrypoint.sh', 0755
     end

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

@@ -1,7 +1,8 @@
 # BUILD IMAGE
-FROM ruby:<%= Modulorails.data.ruby_version %>-alpine as builder
+FROM ruby:<%= @data.ruby_version %>-alpine as builder
 
-ENV RAILS_ENV=production
+ENV RAILS_ENV=production \
+    SECRET_KEY_BASE=1
 WORKDIR /app
 
 RUN apk add --update --no-cache \
@@ -11,27 +12,28 @@ RUN apk add --update --no-cache \
     yarn \
     shared-mime-info \
     gcompat \
-    <%- adapter = Modulorails.data.adapter -%>
-    <%- if adapter =~ /mysql/ -%>
+    <%- if @adapter =~ /mysql/ -%>
     mysql-dev
     <%- else -%>
     postgresql-dev
     <%- end -%>
-RUN gem install bundler -v <%= Modulorails.data.bundler_version %>
+RUN gem install bundler -v <%= @data.bundler_version %>
 
 COPY Gemfile Gemfile.lock ./
 RUN bundle config set --local deployment 'true'
 RUN bundle check || bundle install --jobs=2 \
     && rm -rf vendor/bundle/ruby/*/cache/*
 
+<%- if @webpack_container_needed -%>
 COPY package.json yarn.lock ./
 RUN yarn install
+<%- end-%>
 
 COPY . .
 RUN bundle exec rake assets:precompile
 
 # FINAL IMAGE
-FROM ruby:<%= Modulorails.data.ruby_version %>-alpine
+FROM ruby:<%= @data.ruby_version %>-alpine
 
 ENV RAILS_ENV=development
 ENV EDITOR=vim
@@ -44,8 +46,7 @@ RUN apk add --update --no-cache \
     tzdata \
     shared-mime-info \
     vim \
-    <%- adapter = Modulorails.data.adapter -%>
-    <%- if adapter =~ /mysql/ -%>
+    <%- if @adapter =~ /mysql/ -%>
     mysql-dev \
     <%- else -%>
     postgresql-dev \

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

@@ -1,4 +1,4 @@
-FROM ruby:<%= Modulorails.data.ruby_version %>-alpine
+FROM ruby:<%= @data.ruby_version %>-alpine
 
 ENV RAILS_ENV=development
 ENV EDITOR=vim
@@ -11,13 +11,12 @@ RUN apk add --update --no-cache \
     tzdata \
     gcompat \
     vim \
-    <%- adapter = Modulorails.data.adapter -%>
-    <%- if adapter =~ /mysql/ -%>
+    <%- if @adapter =~ /mysql/ -%>
     mysql-dev
     <%- else -%>
     postgresql-dev
     <%- end -%>
-RUN gem install bundler -v <%= Modulorails.data.bundler_version %>
+RUN gem install bundler -v <%= @data.bundler_version %>
 
 COPY Gemfile Gemfile.lock ./
 RUN bundle install --jobs=2

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

@@ -0,0 +1,15 @@
+redis_local: &redis_local
+  adapter: redis
+  url: <%= ENV.fetch('REDIS_URL', 'redis://redis:6379') %>
+
+development:
+  <<: *redis_local
+
+test:
+  <<: *redis_local
+
+staging:
+  <<: *redis_local
+
+production:
+  <<: *redis_local

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

@@ -1,29 +1,26 @@
-<%- image_name = Modulorails.data.name.parameterize -%>
-<%- upper_image_name = image_name.upcase -%>
-<%- adapter = Modulorails.data.adapter -%>
-<%- if adapter =~ /mysql/ -%>
+<%- 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) %>
+  database: <%%= ENV.fetch('<%= @environment_name %>_DATABASE_NAME', '<%= @image_name %>') %>
+  username: <%%= ENV.fetch('<%= @environment_name %>_DATABASE_USERNAME', 'root') %>
+  password: <%%= ENV.fetch('<%= @environment_name %>_DATABASE_PASSWORD', '') %>
+  host: <%%= ENV.fetch('<%= @environment_name %>_DATABASE_HOST', 'database') %>
+  port: <%%= ENV.fetch('<%= @environment_name %>_DATABASE_PORT', 3306) %>
 <%- else -%>
 development: &default
   adapter: postgresql
-  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) %>
+  database: <%%= ENV.fetch('<%= @environment_name %>_DATABASE_NAME', '<%= @image_name %>') %>
+  username: <%%= ENV.fetch('<%= @environment_name %>_DATABASE_USERNAME', 'postgres') %>
+  password: <%%= ENV.fetch('<%= @environment_name %>_DATABASE_PASSWORD', 'postgres') %>
+  host: <%%= ENV.fetch('<%= @environment_name %>_DATABASE_HOST', 'database') %>
+  port: <%%= ENV.fetch('<%= @environment_name %>_DATABASE_PORT', 5432) %>
 <%- end -%>
 
 test:
   <<: *default
-  database: <%%= ENV.fetch('<%= upper_image_name %>_TEST_DATABASE_NAME', '<%= image_name %>_test') %>
+  database: <%%= ENV.fetch('<%= @environment_name %>_TEST_DATABASE_NAME', '<%= @image_name %>_test') %>
 
 staging:
   <<: *default

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

@@ -1,9 +1,8 @@
 version: '3.7'
 
-<%- image_name = Modulorails.data.name.parameterize -%>
 services:
   app:
-    image: modulotechgroup/<%= image_name %>
+    image: modulotechgroup/<%= @image_name %>
     build:
       context: .
       dockerfile: Dockerfile.prod
@@ -15,35 +14,35 @@ services:
     environment:
       RAILS_ENV: production
       URL: http://localhost:3000
-      <%= image_name.upcase %>_DATABASE_HOST: database
-      <%= image_name.upcase %>_DATABASE_NAME: <%= image_name %>
+      <%= @environment_name %>_DATABASE_HOST: database
+      <%= @environment_name %>_DATABASE_NAME: <%= @image_name %>
       RAILS_SERVE_STATIC_FILES: 'true'
+      REDIS_URL: redis://redis:6379/1
 
-  <%- adapter = Modulorails.data.adapter -%>
-  <%- if adapter =~ /mysql/ -%>
+  <%- 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_DATABASE: <%= @image_name %>
       MYSQL_ROOT_HOST: '%'
   <%- else -%>
   database:
-    image: postgres:13.5
+    image: postgres:15-alpine
     volumes:
       - db_data:/var/lib/postgresql/data
     environment:
       POSTGRES_USER: postgres
       POSTGRES_PASSWORD: postgres
-      POSTGRES_DB: <%= image_name %>
+      POSTGRES_DB: <%= @image_name %>
       LC_COLLATE: 'en_US.UTF-8'
       LC_CTYPE: 'en_US.UTF-8'
   <%- end -%>
 
   redis:
-    image: redis:6.2-alpine
+    image: redis:7-alpine
 
 # Define the volumes references in the services
 volumes:

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

@@ -1,9 +1,8 @@
 version: '3.7'
 
-<%- image_name = Modulorails.data.name.parameterize -%>
 services:
   app:
-    image: modulotechgroup/<%= image_name %>:dev
+    image: modulotechgroup/<%= @image_name %>:dev
     build:
       context: .
       dockerfile: Dockerfile
@@ -17,47 +16,46 @@ services:
     environment:
       RAILS_ENV: development
       URL: http://localhost:3000
-      <%= image_name.upcase %>_DATABASE_HOST: database
-      <%= image_name.upcase %>_DATABASE_NAME: <%= image_name %>
+      <%= @environment_name %>_DATABASE_HOST: database
+      <%= @environment_name %>_DATABASE_NAME: <%= @image_name %>
+      REDIS_URL: redis://redis:6379/1
     entrypoint: ./entrypoints/docker-entrypoint.sh
     stdin_open: true
     tty: true
 
-  <%- adapter = Modulorails.data.adapter -%>
-  <%- if adapter =~ /mysql/ -%>
+  <%- 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_DATABASE: <%= @image_name %>
       MYSQL_ROOT_HOST: '%'
-  <%- else-%>
+  <%- else -%>
   database:
-    image: postgres:13.5
+    image: postgres:15-alpine
     volumes:
       - db_data:/var/lib/postgresql/data
     environment:
       POSTGRES_USER: postgres
       POSTGRES_PASSWORD: postgres
-      POSTGRES_DB: <%= image_name %>
+      POSTGRES_DB: <%= @image_name %>
       LC_COLLATE: 'en_US.UTF-8'
       LC_CTYPE: 'en_US.UTF-8'
-  <%- end-%>
+  <%- end -%>
 
   redis:
-    image: redis:6.2-alpine
+    image: redis:7-alpine
 
   mailcatcher:
-    image: tophfr/mailcatcher
+    image: dockage/mailcatcher
     ports:
-      - 1080:80
+      - 1080:1080
 
-  <%- webpack_container_needed = Modulorails.data.webpacker_version.present? -%>
-  <%- if webpack_container_needed -%>
+  <%- if @webpack_container_needed -%>
   webpack:
-   image: modulotechgroup/<%= image_name %>:dev
+   image: modulotechgroup/<%= @image_name %>:dev
    build:
      context: .
      dockerfile: Dockerfile
@@ -70,7 +68,7 @@ services:
      NODE_ENV: development
      RAILS_ENV: development
      WEBPACKER_DEV_SERVER_HOST: 0.0.0.0
-  <%- end-%>
+  <%- end -%>
 
 volumes:
   db_data:

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

@@ -17,4 +17,4 @@ then
 fi
 
 # Launch the application listening from all origins on port 3000
-./bin/bundle exec rails s -b 0.0.0.0 -p 3000
+exec ./bin/bundle exec rails s -b 0.0.0.0 -p 3000

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

@@ -4,4 +4,4 @@
 set -e
 
 # Launch webpack
-./bin/webpack-dev-server
+exec ./bin/webpack-dev-server

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

@@ -8,8 +8,19 @@ class Modulorails::GitlabciGenerator < Rails::Generators::Base
   desc 'This generator creates a template for a .gitlab-ci.yml file at root'
 
   def create_config_file
+    @data = Modulorails.data
+    @image_name = @data.name.parameterize
+    @environment_name = @data.environment_name
+    @adapter = data.adapter
+    @review_base_url = @data.review_base_url
+    @staging_url = @data.staging_url
+    @production_url = @data.production_url
+
     # Update the gitlab-ci template
     template '.gitlab-ci.yml'
+    template 'config/deploy/production.yaml' if @production_url.present?
+    template 'config/deploy/staging.yaml' if @staging_url.present?
+    template 'config/deploy/review.yaml' if @review_base_url.present?
 
     # Remove the database-ci template if it exists.
     # It used to be referenced by the gitlab-ci template.

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

@@ -1,4 +1,3 @@
-<%- image_name = Modulorails.data.name.parameterize -%>
 include:
   - project: 'modulosource/modulotech/devops/gitlab-ci-templates'
     file:
@@ -6,26 +5,17 @@ include:
       - '/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 %>
-  <%- if adapter =~ /mysql/ -%>
-  MYSQL_DATABASE: <%= image_name %>_test
+  IMAGE_NAME: <%= @image_name %>
+  <%- if @adapter =~ /mysql/ -%>
+  MYSQL_DATABASE: <%= @image_name %>_test
   MYSQL_ALLOW_EMPTY_PASSWORD: 'true'
-  <%= image_name.upcase %>_DATABASE_HOST: mysql
+  <%= @environment_name %>_DATABASE_HOST: mysql
   <%- else -%>
-  POSTGRES_DB: <%= image_name %>_test
+  POSTGRES_DB: <%= @image_name %>_test
   POSTGRES_USER: postgres
   POSTGRES_PASSWORD: postgres
-  <%= image_name.upcase %>_DATABASE_HOST: postgres
+  <%= @environment_name %>_DATABASE_HOST: postgres
   <%- end -%>
 
 stages:
@@ -33,35 +23,44 @@ stages:
   - build
   - deploy
 
+build_integration_image:
+  extends: .build_integration_image
+
 test:
   extends: .test
+  services:
+    <%- if @adapter =~ /mysql/ -%>
+    - mysql:8-alpine
+    <%- else -%>
+    - postgres:15-alpine
+    <%- end -%>
+    - redis:7-alpine
+  variables:
+    RAILS_ENV: 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
+    - bundle exec rake db:create
+    - bundle exec rake db:migrate:reset
+    - bundle exec rspec --format progress --format RspecJunitFormatter --out rspec.xml
 
 docker_build:
   extends: .docker_buildx_push
   only:
     - merge_requests
     - staging
+    - master
 
-<%- review_base_url = Modulorails.data.review_base_url -%>
-<%- if review_base_url.present? -%>
+<%- 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
+    NAMESPACE: <%= @image_name %>-$CI_ENVIRONMENT_SLUG
+    NAME: <%= @image_name %>
+    CHART_NAME: <%= @image_name %>
+    CONFIG_FILE: config/deploy/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.url=$DATABASE_URL --set master_key.key=$MASTER_KEY
   environment:
     name: review/$CI_COMMIT_REF_SLUG
-    url: https://${CI_ENVIRONMENT_SLUG}.<%= review_base_url %>
+    url: https://${CI_ENVIRONMENT_SLUG}.<%= @review_base_url %>
     on_stop: stop_review
     auto_stop_in: 3 days
   only:
@@ -70,56 +69,40 @@ deploy_review:
 stop_review:
   extends: .stop_review
   variables:
-    NAMESPACE: <%= image_name %>-$CI_ENVIRONMENT_SLUG
-    NAME: <%= image_name %>
+    NAMESPACE: <%= @image_name %>-$CI_ENVIRONMENT_SLUG
+    NAME: <%= @image_name %>
   only:
     - merge_requests
 <%- end -%>
 
-<%- staging_url = Modulorails.data.staging_url -%>
-<%- if staging_url.present? -%>
+<%- 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
+    NAMESPACE: <%= @image_name %>
+    NAME: <%= @image_name %>
+    CHART_NAME: <%= @image_name %>
+    CONFIG_FILE: config/deploy/staging.yaml
+    EXTRA_VARS: --set image.tag=$CI_COMMIT_SHORT_SHA --set database.url=$DATABASE_URL --set master_key.key=$MASTER_KEY
   environment:
     name: staging
-    url: https://<%= staging_url %>
-  only:
-    - staging
-<%- else -%>
-deploy_staging:
-  extends: .deploy_capistrano
-  variables:
-    STAGE: staging
+    url: https://<%= @staging_url %>
   only:
     - staging
 <%- end -%>
 
-<%- production_url = Modulorails.data.production_url -%>
-<%- if production_url.present? -%>
+<%- 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
+    NAMESPACE: <%= @image_name %>
+    NAME: <%= @image_name %>
+    CHART_NAME: <%= @image_name %>
+    CONFIG_FILE: config/deploy/production.yaml
+    EXTRA_VARS: --set image.tag=$CI_COMMIT_SHORT_SHA
   environment:
     name: production
-    url: https://<%= production_url %>
-  only:
-    - master
-<%- else -%>
-deploy_production:
-  extends: .deploy_capistrano
-  variables:
-    STAGE: production
+    url: https://<%= @production_url %>
   only:
     - master
 <%- end -%>

data/lib/generators/modulorails/gitlabci/templates/config/deploy/production.yaml.tt

@@ -0,0 +1,43 @@
+imagePullSecrets:
+  - name: regcred
+
+ingress:
+  enabled: true
+  annotations:
+    kubernetes.io/ingress.class: nginx
+    kubernetes.io/tls-acme: 'true'
+  hosts:
+    - host: <%= @production_url %>
+      paths:
+        - path: /
+  tls:
+    - secretName: <%= @image_name %>
+      hosts:
+        - <%= @production_url %>
+
+resources:
+  requests:
+    cpu: 100m
+    memory: 512Mi
+  limits:
+    memory: 512Mi
+
+autoscaling:
+  enabled: true
+  minReplicas: 2
+  maxReplicas: 10
+  targetCPUUtilizationPercentage: 80
+
+database:
+  existingSecret: 'database-credential'
+
+master_key:
+  existingSecret: 'masterkey-credential'
+
+env:
+  RAILS_ENV: production
+  URL: https://<%= @production_url %>/
+
+redis:
+  enabled: false
+  existingSecret: 'redis-credential'

data/lib/generators/modulorails/gitlabci/templates/config/deploy/review.yaml.tt

@@ -0,0 +1,42 @@
+imagePullSecrets:
+  - name: regcred
+
+ingress:
+  enabled: true
+  annotations:
+    kubernetes.io/ingress.class: nginx
+    kubernetes.io/tls-acme: 'true'
+  hosts:
+    - host: $REVIEW_URL
+      paths:
+        - path: /
+  tls:
+    - secretName: <%= @image_name %>
+      hosts:
+        - $REVIEW_URL
+
+resources:
+  requests:
+    cpu: 100m
+    memory: 512Mi
+  limits:
+    memory: 512Mi
+
+autoscaling:
+  enabled: true
+  minReplicas: 1
+  maxReplicas: 10
+  targetCPUUtilizationPercentage: 80
+
+database:
+  url: $DATABASE_URL
+
+master_key:
+  key: $MASTER_KEY
+
+env:
+  RAILS_ENV: staging
+  URL: https://$REVIEW_URL/
+
+redis:
+  enabled: true

data/lib/generators/modulorails/gitlabci/templates/config/deploy/staging.yaml.tt

@@ -0,0 +1,42 @@
+imagePullSecrets:
+  - name: regcred
+
+ingress:
+  enabled: true
+  annotations:
+    kubernetes.io/ingress.class: nginx
+    kubernetes.io/tls-acme: 'true'
+  hosts:
+    - host: <%= @staging_url %>
+      paths:
+        - path: /
+  tls:
+    - secretName: <%= @image_name %>
+      hosts:
+        - <%= @staging_url %>
+
+resources:
+  requests:
+    cpu: 100m
+    memory: 512Mi
+  limits:
+    memory: 512Mi
+
+autoscaling:
+  enabled: true
+  minReplicas: 1
+  maxReplicas: 10
+  targetCPUUtilizationPercentage: 80
+
+database:
+  url: $DATABASE_URL
+
+master_key:
+  key: $MASTER_KEY
+
+env:
+  RAILS_ENV: staging
+  URL: https://<%= @staging_url %>/
+
+redis:
+  enabled: true

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

@@ -13,11 +13,7 @@ class Modulorails::HealthCheckGenerator < Rails::Generators::Base
 
     # 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
+      inject_into_file 'config/routes.rb', "  health_check_routes\n\n", after: "Rails.application.routes.draw do\n"
     end
 
     # Update the gem and the Gemfile.lock

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

@@ -83,7 +83,7 @@ HealthCheck.setup do |config|
   # config.rabbitmq_config = {}
 
   # When redis url/password is non-standard
-  config.redis_url = ENV['REDIS_URL']
+  config.redis_url = ENV.fetch('REDIS_URL', 'redis://redis:6379')
   # Only included if set, as url can optionally include passwords as well
   # config.redis_password = 'redis_password' # default ENV['REDIS_PASSWORD']
 

data/lib/generators/modulorails/rubocop/templates/rubocop.yml.tt

@@ -101,12 +101,12 @@ Metrics/CyclomaticComplexity:
 
 # Commonly used screens these days easily fit more than 80 characters.
 Layout/LineLength:
-  Max: 100
+  Max: 120
 
 # Too short methods lead to extraction of single-use methods, which can make
 # the code easier to read (by naming things), but can also clutter the class
 Metrics/MethodLength:
-  Max: 20
+  Max: 25
 
 # The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
 Metrics/ClassLength:
@@ -265,3 +265,7 @@ Style/ParallelAssignment:
 # Checks the style of children definitions at classes and modules.
 Style/ClassAndModuleChildren:
   Enabled: false
+
+# Useful to display but it really is a bother to change it: hence the `info` severity.
+Rails/I18nLocaleTexts:
+  Severity: info

data/lib/generators/modulorails/service/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Generates a new Modulorails service. Pass the service name, either
+    CamelCased or under_scored, and a list of parameters as arguments.
+
+    To create a service within a module, specify the service name as a
+    path like 'parent_module/service_name'.
+
+    This generates a service class in app/services.
+
+Example:
+    `bin/rails generate modulorails:service Missions::Search word page per`
+
+    Mission::Search service with positional parameters word, page and per.
+        Service: app/services/missions/search_service.rb

data/lib/generators/modulorails/service/service_generator.rb

@@ -8,8 +8,20 @@ class Modulorails::ServiceGenerator < Rails::Generators::NamedBase
   desc 'This generator creates a service inheriting Modulorails::BaseService'
   argument :arguments, type: :array, default: [], banner: 'argument argument'
 
+  check_class_collision suffix: "Service"
+
   def create_service_files
     template 'service.rb', File.join('app/services', class_path, "#{file_name}_service.rb")
   end
 
+  private
+
+  def file_name
+    @_file_name ||= remove_possible_suffix(super)
+  end
+
+  def remove_possible_suffix(name)
+    name.sub(/_?service$/i, '')
+  end
+
 end

data/lib/generators/modulorails/sidekiq/sidekiq_generator.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+class Modulorails::SidekiqGenerator < Rails::Generators::Base
+
+  source_root File.expand_path('templates', __dir__)
+
+  desc 'This generator adds Sidekiq to the project'
+
+  def add_to_docker_compose
+    add_to_docker_compose_yml_file(Rails.root.join('docker-compose.yml'))
+  end
+
+  def add_to_docker_compose_prod
+    add_to_docker_compose_yml_file(Rails.root.join('docker-compose.prod.yml'))
+  end
+
+  def add_to_deploy_files
+    add_to_deploy_file(Rails.root.join('config/deploy/production.yaml'))
+    add_to_deploy_file(Rails.root.join('config/deploy/staging.yaml'))
+    add_to_deploy_file(Rails.root.join('config/deploy/review.yaml'))
+  end
+
+  def add_to_gemfile
+    gemfile_path = Rails.root.join('Gemfile')
+
+    # Add gem redis unless already present
+    unless File.read(gemfile_path).match?(/^\s*gem ['"]redis['"]/)
+      append_to_file(gemfile_path, "gem 'redis'\n")
+    end
+
+    # Add gem sidekiq unless already present
+    unless File.read(gemfile_path).match?(/^\s*gem ['"]sidekiq['"]/)
+      append_to_file(gemfile_path, "gem 'sidekiq'\n")
+    end
+  end
+
+  def add_to_config
+    Dir.glob(Rails.root.join('config/environments/*.rb')) do |file|
+      add_to_config_file(file)
+    end
+  end
+
+  def add_initializer
+    template 'config/initializers/sidekiq.rb'
+  end
+
+  def add_routes
+    routes_path = Rails.root.join('config/routes.rb')
+
+    unless File.read(routes_path).match?(%r{require ['"]sidekiq/web["']})
+      inject_into_file routes_path, after: "Rails.application.routes.draw do\n" do
+        <<-RUBY
+  require 'sidekiq/web'
+  mount Sidekiq::Web => '/sidekiq'
+
+        RUBY
+      end
+    end
+  end
+
+  def add_health_check
+    file_path = Rails.root.join('config/initializers/health_check.rb')
+
+    unless File.read(file_path).match?(%r{add_custom_check\s*\(?\s*['"]sidekiq-queues['"]\s*\)?})
+      inject_into_file file_path, after: /^HealthCheck.setup do \|config\|\n$/ do
+        <<-RUBY
+
+  # 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('sidekiq-queues') do
+    queues = Sidekiq::Queue.all
+
+    # No queues, means no jobs, ok!
+    next '' if queues.empty?
+
+    enqueued_jobs_count = queues.each.map { |queue| queue.count }.sum
+
+    # Less than 200 enqueued jobs, ok!
+    enqueued_jobs_count < 200 ? '' : "\#{enqueued_jobs_count} are currently enqueued."
+  end
+
+  # 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('sidekiq-retries') do
+    retry_jobs_count = Sidekiq::RetrySet.new.count
+
+    # Less than 200 jobs to retry, ok!
+    retry_jobs_count < 200 ? '' : "\#{retry_jobs_count} are waiting for retry."
+  end
+        RUBY
+      end
+    end
+  end
+
+  def add_entrypoint
+    template 'entrypoints/sidekiq-entrypoint.sh'
+    chmod 'entrypoints/sidekiq-entrypoint.sh', 0755
+  end
+
+  private
+
+  def add_to_docker_compose_yml_file(file_path)
+    @image_name ||= Modulorails.data.name.parameterize
+
+    # Create docker-compose.yml unless present
+    unless File.exist?(file_path)
+      # Modulorails::GitlabciGenerator.new([], {}, {}).invoke_all
+      invoke(Modulorails::DockerGenerator, [])
+    end
+
+    return if File.read(file_path).match?(/^ {2}sidekiq:$/)
+
+    insert_into_file file_path, after: /^services:/ do
+      <<-YAML
+
+  sidekiq:
+    image: modulotechgroup/#{@image_name}:dev
+    build:
+      context: .
+      dockerfile: Dockerfile
+    depends_on:
+      - database
+      - redis
+    volumes:
+      - .:/app
+    environment:
+      RAILS_ENV: development
+      URL: http://app:3000
+      #{@image_name.upcase}_DATABASE_HOST: database
+      #{@image_name.upcase}_DATABASE_NAME: #{@image_name}
+      REDIS_URL: redis://redis:6379/1
+    entrypoint: ./entrypoints/sidekiq-entrypoint.sh
+    stdin_open: true
+    tty: true
+      YAML
+    end
+  end
+
+  def add_to_config_file(file_path)
+    pattern = /^(?>\s*)(?>#\s*)?(\w+)\.active_job\.queue_adapter = .+$/
+
+    if File.read(file_path).match?(pattern)
+      gsub_file file_path, pattern, '  \1.active_job.queue_adapter = :sidekiq'
+    else
+      append_file file_path, after: "configure do\n" do
+        <<-RUBY
+  config.active_job.queue_adapter = :sidekiq
+        RUBY
+      end
+    end
+  end
+
+  def add_to_deploy_file(file_path)
+    # Do nothing if file does not exists or Sidekiq is already enabled
+    return if !File.exist?(file_path) || File.read(file_path).match?(/^ {2}sidekiq:$/)
+
+    # Add sidekiq to deploy file
+    insert_into_file file_path do
+      <<-YAML
+
+sidekiq:
+  enabled: true
+  resources:
+    requests:
+      cpu: 100m
+      memory: 512Mi
+    limits:
+      cpu: 100m
+      memory: 512Mi
+  autoscaling:
+    enabled: true
+    minReplicas: 1
+    maxReplicas: 10
+    targetCPUUtilizationPercentage: 80
+      YAML
+    end
+  end
+end

data/lib/generators/modulorails/sidekiq/templates/config/initializers/sidekiq.rb.tt

@@ -0,0 +1,9 @@
+redis_url = Rails.application.config_for('cable')['url']
+
+Sidekiq.configure_server do |config|
+  config.redis = { url: redis_url }
+end
+
+Sidekiq.configure_client do |config|
+  config.redis = { url: redis_url }
+end

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

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+# Exit immediately if a command exits with a non-zero status
+set -e
+
+# Launch Sidekiq
+exec ./bin/bundle exec sidekiq

data/lib/modulorails/data.rb

@@ -15,6 +15,7 @@ module Modulorails
       bundler_version modulorails_version adapter db_version adapter_version webpacker_version
       importmap_version jsbundling_version
       production_url staging_url review_base_url
+      environment_name
     ].freeze
 
     # Useful if the gem's user need to read one of the data
@@ -73,6 +74,9 @@ module Modulorails
       # The name is the usual name of the project, the one used in conversations at Modulotech
       @name = configuration.name
 
+      # A version of the name suitable to name environment variables
+      @environment_name = @name.parameterize.gsub('-', '_').gsub(/\b(\d)/, 'MT_\1').upcase
+
       # The main developer, the lead developer, in short the developer to call when something's
       # wrong with the application ;)
       @main_developer = configuration.main_developer

data/lib/modulorails/version.rb

@@ -1,6 +1,6 @@
 module Modulorails
 
-  VERSION = '1.2.1'.freeze
+  VERSION = '1.3.1'.freeze
 
   # Useful to compare the current Ruby version
   COMPARABLE_RUBY_VERSION = Gem::Version.new(RUBY_VERSION)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modulorails
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.1
 platform: ruby
 authors:
 - Matthieu Ciappara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-09 00:00:00.000000000 Z
+date: 2023-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -202,6 +202,7 @@ files:
 - lib/generators/modulorails/docker/docker_generator.rb
 - lib/generators/modulorails/docker/templates/Dockerfile.prod.tt
 - lib/generators/modulorails/docker/templates/Dockerfile.tt
+- lib/generators/modulorails/docker/templates/config/cable.yml.tt
 - lib/generators/modulorails/docker/templates/config/database.yml.tt
 - lib/generators/modulorails/docker/templates/docker-compose.prod.yml.tt
 - lib/generators/modulorails/docker/templates/docker-compose.yml.tt
@@ -210,14 +211,21 @@ files:
 - lib/generators/modulorails/gitlabci/gitlabci_generator.rb
 - lib/generators/modulorails/gitlabci/templates/.gitlab-ci.yml.tt
 - lib/generators/modulorails/gitlabci/templates/.modulorails-gitlab-ci
+- lib/generators/modulorails/gitlabci/templates/config/deploy/production.yaml.tt
+- lib/generators/modulorails/gitlabci/templates/config/deploy/review.yaml.tt
+- lib/generators/modulorails/gitlabci/templates/config/deploy/staging.yaml.tt
 - lib/generators/modulorails/healthcheck/health_check_generator.rb
 - lib/generators/modulorails/healthcheck/templates/.modulorails-health_check
 - lib/generators/modulorails/healthcheck/templates/config/initializers/health_check.rb.tt
 - lib/generators/modulorails/rubocop/rubocop_generator.rb
 - lib/generators/modulorails/rubocop/templates/rubocop.yml.tt
 - lib/generators/modulorails/self_update/self_update_generator.rb
+- lib/generators/modulorails/service/USAGE
 - lib/generators/modulorails/service/service_generator.rb
 - lib/generators/modulorails/service/templates/service.rb.tt
+- lib/generators/modulorails/sidekiq/sidekiq_generator.rb
+- lib/generators/modulorails/sidekiq/templates/config/initializers/sidekiq.rb.tt
+- lib/generators/modulorails/sidekiq/templates/entrypoints/sidekiq-entrypoint.sh.tt
 - lib/modulorails.rb
 - lib/modulorails/configuration.rb
 - lib/modulorails/data.rb