feature: added suppress_required_validations option

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## master
 
+## 2.6.5 (2024-05-30)
+
+- Added `suppress_required_validations` configuration for skipping validation in CI. ([@OlegChuev][])
+  - Support for the Rails built-in environment variable `SECRET_KEY_BASE_DUMMY`. If this variable is set, all validations for required attributes are skipped. This is particularly useful for executing `bundle exec rails assets:precompile` in CI/CD pipelines.
+
+  - Introduced a global setting `Anyway::Settings.suppress_required_validations = true` to disable validations. This can be toggled via the environment variable `ANYWAY_SUPPRESS_VALIDATIONS`.
+
+  - For Rails applications, `suppress_required_validations` is automatically set to `true` if `SECRET_KEY_BASE_DUMMY` is defined.
+
 ## 2.6.4 (2024-04-30)
 
 - Fix RBS manifest file name (`.yml` -> `.yaml`). ([@carlqt][])
@@ -579,3 +588,4 @@ No we're dependency-free!
 [@tagirahmad]: https://github.com/tagirahmad
 [@bessey]: https://github.com/bessey
 [@carlqt]: https://github.com/carlqt
+[@OlegChuev]: https://github.com/OlegChuev

README.md

@@ -31,29 +31,43 @@ For version 1.x see the [1-4-stable branch](https://github.com/palkan/anyway_con
 
 ## Table of contents
 
-- [Main concepts](#main-concepts)
-- [Installation](#installation)
-- [Usage](#usage)
-  - [Configuration classes](#configuration-classes)
-  - [Dynamic configuration](#dynamic-configuration)
-  - [Validation & Callbacks](#validation-and-callbacks)
-- [Using with Rails applications](#using-with-rails)
-  - [Data population](#data-population)
-  - [Organizing configs](#organizing-configs)
-  - [Generators](#generators)
-- [Using with Ruby applications](#using-with-ruby)
-- [Environment variables](#environment-variables)
-- [Type coercion](#type-coercion)
-- [Local configuration](#local-files)
-- [Data loaders](#data-loaders)
-  - [Doppler integration](#doppler-integration)
-  - [EJSON support](#ejson-support)
-  - [Custom loaders](#custom-loaders)
-- [Source tracing](#tracing)
-- [Pattern matching](#pattern-matching)
-- [Test helpers](#test-helpers)
-- [OptionParser integration](#optionparser-integration)
-- [RBS support](#rbs-support)
+- [Anyway Config](#anyway-config)
+  - [Links](#links)
+  - [Table of contents](#table-of-contents)
+  - [Main concepts](#main-concepts)
+  - [Installation](#installation)
+    - [Supported Ruby versions](#supported-ruby-versions)
+  - [Usage](#usage)
+    - [Configuration classes](#configuration-classes)
+      - [Config name](#config-name)
+      - [Customize env variable names prefix](#customize-env-variable-names-prefix)
+      - [Explicit values](#explicit-values)
+      - [Reload configuration](#reload-configuration)
+    - [Dynamic configuration](#dynamic-configuration)
+    - [Validation and callbacks](#validation-and-callbacks)
+  - [Using with Rails](#using-with-rails)
+    - [Data population](#data-population)
+    - [Multi-env configuration](#multi-env-configuration)
+    - [Organizing configs](#organizing-configs)
+    - [Generators](#generators)
+    - [Loading Anyway Config before Rails](#loading-anyway-config-before-rails)
+  - [Using with Ruby](#using-with-ruby)
+  - [Environment variables](#environment-variables)
+  - [Type coercion](#type-coercion)
+  - [Local files](#local-files)
+  - [Data loaders](#data-loaders)
+    - [Doppler integration](#doppler-integration)
+    - [EJSON support](#ejson-support)
+    - [Custom loaders](#custom-loaders)
+  - [Tracing](#tracing)
+    - [Pretty print](#pretty-print)
+  - [Pattern matching](#pattern-matching)
+  - [Test helpers](#test-helpers)
+  - [OptionParser integration](#optionparser-integration)
+  - [RBS support](#rbs-support)
+    - [Handling `on_load`](#handling-on_load)
+  - [Contributing](#contributing)
+  - [License](#license)
 
 ## Main concepts
 
@@ -304,6 +318,9 @@ MyConfig.new(api_secret: "") #=> raises Anyway::Config::ValidationError
 `Required` method supports additional `env` parameter which indicates necessity to run validations under specified
 environments. `Env` parameter could be present in symbol, string, array or hash formats:
 
+**NOTE:** You can suppress the validation of the required parameters (it can be useful for CI) via the `ANYWAY_SUPPRESS_VALIDATIONS` environment variable or by setting it explicitly in the code: `Anyway::Settings.suppress_required_validations = true`.
+If you are using Anyway Config with Rails and have already specified `SECRET_KEY_BASE_DUMMY` for asset precompilation, validation will be skipped by default.
+
 ```ruby
 class EnvConfig < Anyway::Config
   required :password, env: "production"

lib/anyway/config.rb

@@ -445,6 +445,8 @@ def as_env
     attr_reader :values, :__trace__
 
     def validate_required_attributes!
+      return if Settings.suppress_required_validations
+
       self.class.required_attributes.select do |name|
         val = values.dig(*name.to_s.split(".").map(&:to_sym))
         val.nil? || (val.is_a?(String) && val.empty?)

lib/anyway/rails/settings.rb

@@ -79,5 +79,7 @@ def app_root
     self.use_local_files ||= ::Rails.env.development?
     # Don't try read defaults when no key defined
     self.default_environmental_key = nil
+
+    self.suppress_required_validations = ENV["SECRET_KEY_BASE_DUMMY"]
   end
 end

lib/anyway/settings.rb

@@ -52,6 +52,9 @@ class << self
         :default_environmental_key,
         :known_environments
 
+      # Suppress required validations for CI/CD pipelines
+      attr_accessor :suppress_required_validations
+
       # A proc returning a path to YML config file given the config name
       attr_reader :default_config_path
 
@@ -107,5 +110,8 @@ def matching_env?(env)
 
     # Tracing is enabled by default
     self.tracing_enabled = true
+
+    # By default, use ANYWAY_SUPPRESS_VALIDATIONS
+    self.suppress_required_validations = ENV["ANYWAY_SUPPRESS_VALIDATIONS"]
   end
 end

sig/anyway_config.rbs

@@ -7,6 +7,7 @@ module Anyway
     def self.future: -> Future
     def self.current_environment: -> String?
     def self.default_environmental_key: -> String?
+    def self.suppress_required_validations: -> bool?
     def self.known_environments: -> Array[String]?
 
     class Future

spec/config_spec.rb

@@ -934,6 +934,26 @@ def self.name
         .to raise_error(ArgumentError, /unknown config param: test/i)
     end
 
+    context "suppress validation" do
+      let(:config_values) { {} }
+
+      context "with setting" do
+        before { allow(Anyway::Settings).to receive(:suppress_required_validations).and_return(true) }
+
+        it "not to raise ValidationError" do
+          expect { subject }.to_not raise_error
+        end
+      end
+
+      context "with env" do
+        it "not to raise ValidationError" do
+          with_env("ANYWAY_SUPPRESS_VALIDATIONS" => "1") do
+            expect { subject }.to_not raise_error
+          end
+        end
+      end
+    end
+
     specify "inheritance" do
       subconfig = Class.new(config) { required :debug }
 

spec/rails/config_spec.rb

@@ -113,5 +113,19 @@
       expect { MyAppConfig.new }
         .to raise_error(Anyway::Config::ValidationError, /missing or empty: name, mode/)
     end
+
+    context "when suppress validation" do
+      context "manually with setting" do
+        around do |ex|
+          Anyway::Settings.suppress_required_validations = true
+          ex.run
+          Anyway::Settings.suppress_required_validations = false
+        end
+
+        it "skips validation" do
+          expect { MyAppConfig.new }.to_not raise_error
+        end
+      end
+    end
   end
 end