go-validot

go-validot is a robust Go package designed to validate .env files, ensuring that your application's environment configurations are correctly set and adhere to specified standards. With support for custom plugins, comprehensive configuration options, and a suite of examples, go-validot offers a flexible solution for managing environment variables effectively.

MIT License

Features

Validation of Required Keys: Ensure that essential environment variables are present.
Customizable Validation Rules: Define and enforce specific rules for environment variable values.
Plugin Architecture: Extend functionality with custom validation plugins.
Verbose Logging: Gain insights into the validation process with detailed logs.
Graceful Handling of Invalid Lines: Skip malformed lines without halting the validation process.
Support for Multiple Data Types: Validate URLs, enums, IP addresses, booleans, and more.

Installation

To install go-validot, use the go get command:

go get github.com/mwiater/go-validot

Ensure that you have Go installed and properly configured on your system.

Usage

Using go-validot is straightforward. Below is a basic example of how to integrate it into your Go project:

// examples/default_usage/main.go
package main

import (
	"github.com/mwiater/go-validot"
)

func main() {
	// Define required keys
	requiredKeys := []string{"API_KEY", "DB_HOST", "API_URL", "ENVIRONMENT", "ENABLE_DEBUG", "TRUSTED_PROXY_IP"}

	// Create a new validator with default settings
	validator := validot.NewValidator(validot.Config{}, requiredKeys)

	// Validate the .env file
	_ = validator.ValidateDotEnv(".env") // No need to log success here
}

Ensure that your .env file is present in the expected location and run your application as usual. The validator will check the .env file against the defined rules and log the results accordingly.

Examples

go-validot comes with a set of example projects that demonstrate various validation scenarios. Each example resides in the examples/ directory and showcases how to implement specific validation rules.

Available Examples

NOTE: To show functionality, most of the examples have the validot.Config Verbose set to true.

Creating a validator with default settings:

validator := validot.NewValidator(validot.Config{}, requiredKeys)

Is equivalent to:

	validator := validot.NewValidator(validot.Config{
		RequireQuotes: false,  // Don't nforce that values must be quoted
		Verbose:       false,  // EnDisableable verbose logging
		Logger:        nil,    // Don't use a custom logger
		Plugins:       nil,    // Only use built-in plugins
	}, requiredKeys)

Custom Logger

Description: Pass a custom logrus logger to format your logs. The following example just shows changing the logging to JSON instead of text.
How to Run:
```
cd examples/custom_logger
go run .
```

Expected Output:

{"level":"info","msg":"Validator Configuration:","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  RequireQuotes: false","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  Verbose: true","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  Number of Plugins: 4","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"End of Configuration","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Starting validation for file: .env","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: DB_PORT","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  DB_PORT is an optional variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: ENVIRONMENT","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  ENVIRONMENT is a required variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  [Validated by: EnumValidationPlugin]","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: LOG_FORMAT","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  LOG_FORMAT is an optional variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: ENABLE_FEATURE_Y","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  ENABLE_FEATURE_Y is an optional variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: DB_NAME","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  DB_NAME is an optional variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: CACHE_SIZE","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  CACHE_SIZE is an optional variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: USE_SSL","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  USE_SSL is an optional variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: DB_USER","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  DB_USER is an optional variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: API_KEY","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  API_KEY is a required variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: ENABLE_FEATURE_X","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  ENABLE_FEATURE_X is an optional variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: SERVICE_ENDPOINT","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  SERVICE_ENDPOINT is an optional variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: REDIS_HOST","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  REDIS_HOST is an optional variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: LOG_LEVEL","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  LOG_LEVEL is an optional variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: SERVICE_VERSION","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  SERVICE_VERSION is an optional variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: DB_PASSWORD","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  DB_PASSWORD is an optional variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: TRUSTED_PROXY_IP","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  TRUSTED_PROXY_IP is a required variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  [Validated by: IPAddressValidationPlugin]","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: REDIS_PORT","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  REDIS_PORT is an optional variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: UPLOAD_LIMIT","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  UPLOAD_LIMIT is an optional variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: ENABLE_DEBUG","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  ENABLE_DEBUG is a required variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  [Validated by: BooleanValidationPlugin]","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: DB_HOST","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  DB_HOST is a required variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: SERVICE_TIMEOUT","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  SERVICE_TIMEOUT is an optional variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: API_SECRET","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  API_SECRET is an optional variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: API_TIMEOUT","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  API_TIMEOUT is an optional variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"Processing key: API_URL","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  API_URL is a required variable.","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":"  [Validated by: URLValidationPlugin]","time":"2024-12-03T17:19:57-08:00"}
{"level":"info","msg":".env file is valid.","time":"2024-12-03T17:19:57-08:00"}

Boolean Validation

Description: Validates boolean environment variables, ensuring they accept only predefined boolean values.
How to Run:
```
cd examples/boolean_validation
go run .
```

Expected Output:

INFO[2024-12-03T10:17:43-08:00] Validator Configuration:
INFO[2024-12-03T10:17:43-08:00]   RequireQuotes: true
INFO[2024-12-03T10:17:43-08:00]   Verbose: true
INFO[2024-12-03T10:17:43-08:00]   Number of Plugins: 4
INFO[2024-12-03T10:17:43-08:00] End of Configuration
INFO[2024-12-03T10:17:43-08:00] Starting validation for file: .env
INFO[2024-12-03T10:17:43-08:00] Processing key: REDIS_PORT
INFO[2024-12-03T10:17:43-08:00]   REDIS_PORT is an optional variable.
INFO[2024-12-03T10:17:43-08:00] Processing key: API_KEY
INFO[2024-12-03T10:17:43-08:00]   API_KEY is an optional variable.
INFO[2024-12-03T10:17:43-08:00] Processing key: ENABLE_FEATURE_Y
INFO[2024-12-03T10:17:43-08:00]   ENABLE_FEATURE_Y is an optional variable.
INFO[2024-12-03T10:17:43-08:00] Processing key: REDIS_HOST
INFO[2024-12-03T10:17:43-08:00]   REDIS_HOST is an optional variable.
INFO[2024-12-03T10:17:43-08:00] Processing key: ENABLE_DEBUG
INFO[2024-12-03T10:17:43-08:00]   ENABLE_DEBUG is a required variable.
INFO[2024-12-03T10:17:43-08:00]   [Validated by: BooleanValidationPlugin]
INFO[2024-12-03T10:17:43-08:00] Processing key: USE_SSL
INFO[2024-12-03T10:17:43-08:00]   USE_SSL is a required variable.
INFO[2024-12-03T10:17:43-08:00] Processing key: DB_PORT
INFO[2024-12-03T10:17:43-08:00]   DB_PORT is an optional variable.
INFO[2024-12-03T10:17:43-08:00] Processing key: ENVIRONMENT
INFO[2024-12-03T10:17:43-08:00]   ENVIRONMENT is an optional variable.
INFO[2024-12-03T10:17:43-08:00]   [Validated by: EnumValidationPlugin]
INFO[2024-12-03T10:17:43-08:00] Processing key: ENABLE_FEATURE_X
INFO[2024-12-03T10:17:43-08:00]   ENABLE_FEATURE_X is an optional variable.
INFO[2024-12-03T10:17:43-08:00] Processing key: TRUSTED_PROXY_IP
INFO[2024-12-03T10:17:43-08:00]   TRUSTED_PROXY_IP is an optional variable.
INFO[2024-12-03T10:17:43-08:00]   [Validated by: IPAddressValidationPlugin]
INFO[2024-12-03T10:17:43-08:00] Processing key: API_SECRET
INFO[2024-12-03T10:17:43-08:00]   API_SECRET is an optional variable.
INFO[2024-12-03T10:17:43-08:00] Processing key: SERVICE_TIMEOUT
INFO[2024-12-03T10:17:43-08:00]   SERVICE_TIMEOUT is an optional variable.
INFO[2024-12-03T10:17:43-08:00] Processing key: SERVICE_ENDPOINT
INFO[2024-12-03T10:17:43-08:00]   SERVICE_ENDPOINT is an optional variable.
INFO[2024-12-03T10:17:43-08:00] Processing key: SERVICE_VERSION
INFO[2024-12-03T10:17:43-08:00]   SERVICE_VERSION is an optional variable.
INFO[2024-12-03T10:17:43-08:00] Processing key: DB_PASSWORD
INFO[2024-12-03T10:17:43-08:00]   DB_PASSWORD is an optional variable.
INFO[2024-12-03T10:17:43-08:00] Processing key: LOG_LEVEL
INFO[2024-12-03T10:17:43-08:00]   LOG_LEVEL is an optional variable.
INFO[2024-12-03T10:17:43-08:00] Processing key: CACHE_SIZE
INFO[2024-12-03T10:17:43-08:00]   CACHE_SIZE is an optional variable.
INFO[2024-12-03T10:17:43-08:00] Processing key: DB_HOST
INFO[2024-12-03T10:17:43-08:00]   DB_HOST is a required variable.
INFO[2024-12-03T10:17:43-08:00] Processing key: UPLOAD_LIMIT
INFO[2024-12-03T10:17:43-08:00]   UPLOAD_LIMIT is an optional variable.
INFO[2024-12-03T10:17:43-08:00] Processing key: DB_USER
INFO[2024-12-03T10:17:43-08:00]   DB_USER is an optional variable.
INFO[2024-12-03T10:17:43-08:00] Processing key: API_URL
INFO[2024-12-03T10:17:43-08:00]   API_URL is an optional variable.
INFO[2024-12-03T10:17:43-08:00]   [Validated by: URLValidationPlugin]
INFO[2024-12-03T10:17:43-08:00] Processing key: API_TIMEOUT
INFO[2024-12-03T10:17:43-08:00]   API_TIMEOUT is an optional variable.
INFO[2024-12-03T10:17:43-08:00] Processing key: LOG_FORMAT
INFO[2024-12-03T10:17:43-08:00]   LOG_FORMAT is an optional variable.
INFO[2024-12-03T10:17:43-08:00] Processing key: DB_NAME
INFO[2024-12-03T10:17:43-08:00]   DB_NAME is an optional variable.
INFO[2024-12-03T10:17:43-08:00] Processing key: FEATURE_FLAG_NEW_UI
INFO[2024-12-03T10:17:43-08:00]   FEATURE_FLAG_NEW_UI is a required variable.
INFO[2024-12-03T10:17:43-08:00] .env file is valid.

Default Usage

Description: Demonstrates the basic usage of go-validot without any custom plugins.
How to Run:
```
cd examples/default_usage
go run .
```

Expected Output:

INFO[2024-12-03T10:20:10-08:00] Starting validation for file: .env
INFO[2024-12-03T10:20:10-08:00] .env file is valid.

Enum Validation

Description: Ensures that specific environment variables match one of the allowed enumerated values.
How to Run:
```
cd examples/enum_validation
go run .
```

Expected Output:

INFO[2024-12-03T10:20:38-08:00] Validator Configuration:
INFO[2024-12-03T10:20:38-08:00]   RequireQuotes: true
INFO[2024-12-03T10:20:38-08:00]   Verbose: true
INFO[2024-12-03T10:20:38-08:00]   Number of Plugins: 4
INFO[2024-12-03T10:20:38-08:00] End of Configuration
INFO[2024-12-03T10:20:38-08:00] Starting validation for file: .env
INFO[2024-12-03T10:20:38-08:00] Processing key: SERVICE_TIMEOUT
INFO[2024-12-03T10:20:38-08:00]   SERVICE_TIMEOUT is an optional variable.
INFO[2024-12-03T10:20:38-08:00] Processing key: DB_PORT
INFO[2024-12-03T10:20:38-08:00]   DB_PORT is an optional variable.
INFO[2024-12-03T10:20:38-08:00] Processing key: USE_SSL
INFO[2024-12-03T10:20:38-08:00]   USE_SSL is an optional variable.
INFO[2024-12-03T10:20:38-08:00] Processing key: API_SECRET
INFO[2024-12-03T10:20:38-08:00]   API_SECRET is an optional variable.
INFO[2024-12-03T10:20:38-08:00] Processing key: SERVICE_VERSION
INFO[2024-12-03T10:20:38-08:00]   SERVICE_VERSION is an optional variable.
INFO[2024-12-03T10:20:38-08:00] Processing key: TRUSTED_PROXY_IP
INFO[2024-12-03T10:20:38-08:00]   TRUSTED_PROXY_IP is an optional variable.
INFO[2024-12-03T10:20:38-08:00]   [Validated by: IPAddressValidationPlugin]
INFO[2024-12-03T10:20:38-08:00] Processing key: REDIS_PORT
INFO[2024-12-03T10:20:38-08:00]   REDIS_PORT is an optional variable.
INFO[2024-12-03T10:20:38-08:00] Processing key: DB_USER
INFO[2024-12-03T10:20:38-08:00]   DB_USER is an optional variable.
INFO[2024-12-03T10:20:38-08:00] Processing key: REDIS_HOST
INFO[2024-12-03T10:20:38-08:00]   REDIS_HOST is an optional variable.
INFO[2024-12-03T10:20:38-08:00] Processing key: ENABLE_FEATURE_Y
INFO[2024-12-03T10:20:38-08:00]   ENABLE_FEATURE_Y is an optional variable.
INFO[2024-12-03T10:20:38-08:00] Processing key: ENVIRONMENT
INFO[2024-12-03T10:20:38-08:00]   ENVIRONMENT is a required variable.
INFO[2024-12-03T10:20:38-08:00]   [Validated by: EnumValidationPlugin]
INFO[2024-12-03T10:20:38-08:00] Processing key: LOG_FORMAT
INFO[2024-12-03T10:20:38-08:00]   LOG_FORMAT is an optional variable.
INFO[2024-12-03T10:20:38-08:00] Processing key: DB_HOST
INFO[2024-12-03T10:20:38-08:00]   DB_HOST is a required variable.
INFO[2024-12-03T10:20:38-08:00] Processing key: SERVICE_ENDPOINT
INFO[2024-12-03T10:20:38-08:00]   SERVICE_ENDPOINT is an optional variable.
INFO[2024-12-03T10:20:38-08:00] Processing key: CACHE_SIZE
INFO[2024-12-03T10:20:38-08:00]   CACHE_SIZE is an optional variable.
INFO[2024-12-03T10:20:38-08:00] Processing key: API_KEY
INFO[2024-12-03T10:20:38-08:00]   API_KEY is an optional variable.
INFO[2024-12-03T10:20:38-08:00] Processing key: API_URL
INFO[2024-12-03T10:20:38-08:00]   API_URL is an optional variable.
INFO[2024-12-03T10:20:38-08:00]   [Validated by: URLValidationPlugin]
INFO[2024-12-03T10:20:38-08:00] Processing key: ENABLE_FEATURE_X
INFO[2024-12-03T10:20:38-08:00]   ENABLE_FEATURE_X is an optional variable.
INFO[2024-12-03T10:20:38-08:00] Processing key: LOG_LEVEL
INFO[2024-12-03T10:20:38-08:00]   LOG_LEVEL is a required variable.
INFO[2024-12-03T10:20:38-08:00] Processing key: UPLOAD_LIMIT
INFO[2024-12-03T10:20:38-08:00]   UPLOAD_LIMIT is an optional variable.
INFO[2024-12-03T10:20:38-08:00] Processing key: API_TIMEOUT
INFO[2024-12-03T10:20:38-08:00]   API_TIMEOUT is an optional variable.
INFO[2024-12-03T10:20:38-08:00] Processing key: DB_PASSWORD
INFO[2024-12-03T10:20:38-08:00]   DB_PASSWORD is an optional variable.
INFO[2024-12-03T10:20:38-08:00] Processing key: DB_NAME
INFO[2024-12-03T10:20:38-08:00]   DB_NAME is an optional variable.
INFO[2024-12-03T10:20:38-08:00] Processing key: ENABLE_DEBUG
INFO[2024-12-03T10:20:38-08:00]   ENABLE_DEBUG is an optional variable.
INFO[2024-12-03T10:20:38-08:00]   [Validated by: BooleanValidationPlugin]
INFO[2024-12-03T10:20:38-08:00] .env file is valid.

IP Address Validation

Description: Validates that IP address environment variables are within private IP ranges.

How to Run:

cd examples/ip_address_validation
go run .

Expected Output:

INFO[2024-12-03T10:22:56-08:00] Validator Configuration:
INFO[2024-12-03T10:22:56-08:00]   RequireQuotes: true
INFO[2024-12-03T10:22:56-08:00]   Verbose: true
INFO[2024-12-03T10:22:56-08:00]   Number of Plugins: 4
INFO[2024-12-03T10:22:56-08:00] End of Configuration
INFO[2024-12-03T10:22:56-08:00] Starting validation for file: .env
INFO[2024-12-03T10:22:56-08:00] Processing key: DATABASE_IP
INFO[2024-12-03T10:22:56-08:00]   DATABASE_IP is a required variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: DB_USER
INFO[2024-12-03T10:22:56-08:00]   DB_USER is an optional variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: API_KEY
INFO[2024-12-03T10:22:56-08:00]   API_KEY is an optional variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: SERVICE_VERSION
INFO[2024-12-03T10:22:56-08:00]   SERVICE_VERSION is an optional variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: DB_PASSWORD
INFO[2024-12-03T10:22:56-08:00]   DB_PASSWORD is an optional variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: CACHE_SIZE
INFO[2024-12-03T10:22:56-08:00]   CACHE_SIZE is an optional variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: API_SECRET
INFO[2024-12-03T10:22:56-08:00]   API_SECRET is an optional variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: DB_HOST
INFO[2024-12-03T10:22:56-08:00]   DB_HOST is a required variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: API_URL
INFO[2024-12-03T10:22:56-08:00]   API_URL is an optional variable.
INFO[2024-12-03T10:22:56-08:00]   [Validated by: URLValidationPlugin]
INFO[2024-12-03T10:22:56-08:00] Processing key: TRUSTED_PROXY_IP
INFO[2024-12-03T10:22:56-08:00]   TRUSTED_PROXY_IP is a required variable.
INFO[2024-12-03T10:22:56-08:00]   [Validated by: IPAddressValidationPlugin]
INFO[2024-12-03T10:22:56-08:00] Processing key: DB_PORT
INFO[2024-12-03T10:22:56-08:00]   DB_PORT is an optional variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: LOG_FORMAT
INFO[2024-12-03T10:22:56-08:00]   LOG_FORMAT is an optional variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: UPLOAD_LIMIT
INFO[2024-12-03T10:22:56-08:00]   UPLOAD_LIMIT is an optional variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: ENABLE_DEBUG
INFO[2024-12-03T10:22:56-08:00]   ENABLE_DEBUG is an optional variable.
INFO[2024-12-03T10:22:56-08:00]   [Validated by: BooleanValidationPlugin]
INFO[2024-12-03T10:22:56-08:00] Processing key: USE_SSL
INFO[2024-12-03T10:22:56-08:00]   USE_SSL is an optional variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: ENABLE_FEATURE_X
INFO[2024-12-03T10:22:56-08:00]   ENABLE_FEATURE_X is an optional variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: ENABLE_FEATURE_Y
INFO[2024-12-03T10:22:56-08:00]   ENABLE_FEATURE_Y is an optional variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: REDIS_PORT
INFO[2024-12-03T10:22:56-08:00]   REDIS_PORT is an optional variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: LOG_LEVEL
INFO[2024-12-03T10:22:56-08:00]   LOG_LEVEL is an optional variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: REDIS_HOST
INFO[2024-12-03T10:22:56-08:00]   REDIS_HOST is an optional variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: SERVICE_TIMEOUT
INFO[2024-12-03T10:22:56-08:00]   SERVICE_TIMEOUT is an optional variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: DB_NAME
INFO[2024-12-03T10:22:56-08:00]   DB_NAME is an optional variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: API_TIMEOUT
INFO[2024-12-03T10:22:56-08:00]   API_TIMEOUT is an optional variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: SERVICE_ENDPOINT
INFO[2024-12-03T10:22:56-08:00]   SERVICE_ENDPOINT is an optional variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: FEATURE_FLAG_NEW_UI
INFO[2024-12-03T10:22:56-08:00]   FEATURE_FLAG_NEW_UI is an optional variable.
INFO[2024-12-03T10:22:56-08:00] Processing key: ENVIRONMENT
INFO[2024-12-03T10:22:56-08:00]   ENVIRONMENT is an optional variable.
INFO[2024-12-03T10:22:56-08:00]   [Validated by: EnumValidationPlugin]
INFO[2024-12-03T10:22:56-08:00] .env file is valid.

URL Validation

Description: Ensures that URL environment variables use secure schemes like https.
How to Run:
```
cd examples/url_validation
go run .
```

Expected Output:

INFO[2024-12-03T10:23:26-08:00] Validator Configuration:
INFO[2024-12-03T10:23:26-08:00]   RequireQuotes: true
INFO[2024-12-03T10:23:26-08:00]   Verbose: true
INFO[2024-12-03T10:23:26-08:00]   Number of Plugins: 4
INFO[2024-12-03T10:23:26-08:00] End of Configuration
INFO[2024-12-03T10:23:26-08:00] Starting validation for file: .env
INFO[2024-12-03T10:23:26-08:00] Processing key: ENABLE_FEATURE_X
INFO[2024-12-03T10:23:26-08:00]   ENABLE_FEATURE_X is an optional variable.
INFO[2024-12-03T10:23:26-08:00] Processing key: LOG_LEVEL
INFO[2024-12-03T10:23:26-08:00]   LOG_LEVEL is an optional variable.
INFO[2024-12-03T10:23:26-08:00] Processing key: USE_SSL
INFO[2024-12-03T10:23:26-08:00]   USE_SSL is an optional variable.
INFO[2024-12-03T10:23:26-08:00] Processing key: DB_PASSWORD
INFO[2024-12-03T10:23:26-08:00]   DB_PASSWORD is an optional variable.
INFO[2024-12-03T10:23:26-08:00] Processing key: TRUSTED_PROXY_IP
INFO[2024-12-03T10:23:26-08:00]   TRUSTED_PROXY_IP is an optional variable.
INFO[2024-12-03T10:23:26-08:00]   [Validated by: IPAddressValidationPlugin]
INFO[2024-12-03T10:23:26-08:00] Processing key: REDIS_PORT
INFO[2024-12-03T10:23:26-08:00]   REDIS_PORT is an optional variable.
INFO[2024-12-03T10:23:26-08:00] Processing key: DB_NAME
INFO[2024-12-03T10:23:26-08:00]   DB_NAME is an optional variable.
INFO[2024-12-03T10:23:26-08:00] Processing key: REDIS_HOST
INFO[2024-12-03T10:23:26-08:00]   REDIS_HOST is an optional variable.
INFO[2024-12-03T10:23:26-08:00] Processing key: DB_PORT
INFO[2024-12-03T10:23:26-08:00]   DB_PORT is an optional variable.
INFO[2024-12-03T10:23:26-08:00] Processing key: LOG_FORMAT
INFO[2024-12-03T10:23:26-08:00]   LOG_FORMAT is an optional variable.
INFO[2024-12-03T10:23:26-08:00] Processing key: SERVICE_ENDPOINT
INFO[2024-12-03T10:23:26-08:00]   SERVICE_ENDPOINT is a required variable.
INFO[2024-12-03T10:23:26-08:00] Processing key: SERVICE_VERSION
INFO[2024-12-03T10:23:26-08:00]   SERVICE_VERSION is an optional variable.
INFO[2024-12-03T10:23:26-08:00] Processing key: API_URL
INFO[2024-12-03T10:23:26-08:00]   API_URL is a required variable.
INFO[2024-12-03T10:23:26-08:00]   [Validated by: URLValidationPlugin]
INFO[2024-12-03T10:23:26-08:00] Processing key: DB_USER
INFO[2024-12-03T10:23:26-08:00]   DB_USER is an optional variable.
INFO[2024-12-03T10:23:26-08:00] Processing key: ENABLE_FEATURE_Y
INFO[2024-12-03T10:23:26-08:00]   ENABLE_FEATURE_Y is an optional variable.
INFO[2024-12-03T10:23:26-08:00] Processing key: SERVICE_TIMEOUT
INFO[2024-12-03T10:23:26-08:00]   SERVICE_TIMEOUT is an optional variable.
INFO[2024-12-03T10:23:26-08:00] Processing key: DB_HOST
INFO[2024-12-03T10:23:26-08:00]   DB_HOST is a required variable.
INFO[2024-12-03T10:23:26-08:00] Processing key: ENABLE_DEBUG
INFO[2024-12-03T10:23:26-08:00]   ENABLE_DEBUG is an optional variable.
INFO[2024-12-03T10:23:26-08:00]   [Validated by: BooleanValidationPlugin]
INFO[2024-12-03T10:23:26-08:00] Processing key: API_SECRET
INFO[2024-12-03T10:23:26-08:00]   API_SECRET is an optional variable.
INFO[2024-12-03T10:23:26-08:00] Processing key: ENVIRONMENT
INFO[2024-12-03T10:23:26-08:00]   ENVIRONMENT is an optional variable.
INFO[2024-12-03T10:23:26-08:00]   [Validated by: EnumValidationPlugin]
INFO[2024-12-03T10:23:26-08:00] Processing key: API_TIMEOUT
INFO[2024-12-03T10:23:26-08:00]   API_TIMEOUT is an optional variable.
INFO[2024-12-03T10:23:26-08:00] Processing key: UPLOAD_LIMIT
INFO[2024-12-03T10:23:26-08:00]   UPLOAD_LIMIT is an optional variable.
INFO[2024-12-03T10:23:26-08:00] Processing key: API_KEY
INFO[2024-12-03T10:23:26-08:00]   API_KEY is an optional variable.
INFO[2024-12-03T10:23:26-08:00] Processing key: CACHE_SIZE
INFO[2024-12-03T10:23:26-08:00]   CACHE_SIZE is an optional variable.
INFO[2024-12-03T10:23:26-08:00] .env file is valid.

Configuration

go-validot offers a flexible configuration system to tailor the validation process to your project's needs. Below are the primary configuration options:

RequireQuotes (bool):
Enforces that all environment variable values must be enclosed in quotes.
Default: false
Verbose (bool):
Enables detailed logging of the validation process, providing insights into each validation step.
Default: false
Logger (*logrus.Logger):
Allows you to specify a custom logger instance. By default, go-validot uses logrus.
Default: Initialized with logrus.New()
Plugins ([]ValidationPlugin):
A slice of custom validation plugins to extend go-validot's functionality. Plugins can enforce additional rules beyond the core validations.

Example Configuration

validator := validot.NewValidator(validot.Config{
    RequireQuotes: true,
    Verbose:       true,
    Logger:        logger,
    Plugins:       []validot.ValidationPlugin{&validot.CacheSizeValidationPlugin{}},
}, requiredKeys)

Plugins

go-validot supports a plugin architecture, allowing developers to create and integrate custom validation rules seamlessly. Below are descriptions of the available plugins:

1. BooleanValidationPlugin

Description:

Validates that specified environment variables are boolean values. Ensures that variables like ENABLE_DEBUG accept only predefined boolean representations (e.g., true, false, 1, 0, yes, no).
Usage:

Integrate the plugin into the validator's configuration to enforce boolean constraints on relevant keys.
Example Behavior:
- Valid:
  - ENABLE_DEBUG="true"
  - ENABLE_FEATURE_X="1"
- Invalid:
  - ENABLE_DEBUG="maybe"
  - ENABLE_FEATURE_X="enabled"

2. EnumValidationPlugin

Description:

Ensures that specific environment variables match one of the allowed enumerated values. Useful for variables like ENVIRONMENT which should be DEVELOPMENT, STAGING, or PRODUCTION.
Usage:

Configure the plugin with the allowed values for each key you wish to validate.
Example Behavior:
- Valid:
  - ENVIRONMENT="PRODUCTION"
  - LOG_LEVEL="INFO"
- Invalid:
  - ENVIRONMENT="TESTING"
  - LOG_LEVEL="VERBOSE"

3. IPAddressValidationPlugin

Description:

Checks that IP address environment variables are within private IP ranges, enhancing security by preventing the use of public IPs where inappropriate.
Usage:

Integrate the plugin and specify which keys should be validated as private IP addresses.
Example Behavior:
- Valid:
  - TRUSTED_PROXY_IP="192.168.1.100"
- Invalid:
  - TRUSTED_PROXY_IP="8.8.8.8"

4. URLValidationPlugin

Description:

Ensures that URL environment variables use secure schemes such as https. This plugin can be configured to enforce specific schemes for different keys.
Usage:

Add the plugin to the validator and specify which keys should adhere to certain URL schemes.
Example Behavior:
- Valid:
  - API_URL="https://api.example.com"
- Invalid:
  - API_URL="http://api.example.com" (Insecure scheme)

Creating Custom Plugins

To create a custom plugin, implement the ValidationPlugin interface:

type ValidationPlugin interface {
    Validate(key, value string) (handled bool, err error)
    Name() string
}

Example:

type CustomPlugin struct{}

func (p *CustomPlugin) Validate(key, value string) (bool, error) {
    if key == "CUSTOM_KEY" {
        // Implement custom validation logic
        return true, nil
    }
    return false, nil
}

func (p *CustomPlugin) Name() string {
    return "CustomPlugin"
}

Integrate the custom plugin into the validator:

validator := validot.NewValidator(validot.Config{
    RequireQuotes: true,
    Verbose:       true,
    Logger:        logger,
    Plugins:       []validot.ValidationPlugin{&CustomPlugin{}},
}, requiredKeys)

Best Practices

To maximize the effectiveness of go-validot, consider the following best practices:

Define Clear Validation Rules:
- Clearly outline which environment variables are required and what constraints they should adhere to. This clarity helps in setting up accurate validation rules.
Use Verbose Logging During Development:
- Enable verbose logging to gain detailed insights into the validation process, making it easier to debug and refine your validation rules.
Leverage Plugins for Custom Validations:
- Utilize the plugin architecture to enforce specific rules that are unique to your application's requirements. This extensibility ensures that go-validot remains adaptable to various scenarios.
Regularly Update Validation Rules:
- As your application evolves, revisit and update your validation rules to accommodate new environment variables or changes in existing ones.
Handle Sensitive Information Securely:
- Ensure that sensitive environment variables, such as API keys and passwords, are handled securely. Consider integrating additional plugins or mechanisms to validate and protect such data.
Integrate with CI/CD Pipelines:
- Incorporate go-validot into your continuous integration and deployment pipelines to automatically validate environment configurations before deploying applications.

Running the Tests

To ensure the integrity and reliability of go-validot, a comprehensive test suite is provided. Running the tests verifies that all validation rules and plugins function as expected.

How to Run the Tests

Execute the following command in your terminal:

go test -v ./...

Expected Output

Upon running the tests, you should see output indicating the status of each test case. Below is an example of a successful test run:

?       github.com/mwiater/go-validot/examples/boolean_validation       [no test files]
?       github.com/mwiater/go-validot/examples/default_usage    [no test files]
=== RUN   TestValidateDotEnv_ValidFile
--- PASS: TestValidateDotEnv_ValidFile (0.00s)
=== RUN   TestValidateDotEnv_MissingRequiredKeys
--- PASS: TestValidateDotEnv_MissingRequiredKeys (0.00s)
=== RUN   TestValidateDotEnv_InvalidURL
--- PASS: TestValidateDotEnv_InvalidURL (0.00s)
=== RUN   TestValidateDotEnv_InvalidEnum
--- PASS: TestValidateDotEnv_InvalidEnum (0.00s)
=== RUN   TestValidateDotEnv_InvalidBoolean
--- PASS: TestValidateDotEnv_InvalidBoolean (0.00s)
=== RUN   TestValidateDotEnv_InvalidIPAddress
--- PASS: TestValidateDotEnv_InvalidIPAddress (0.00s)
=== RUN   TestValidateDotEnv_DuplicateKeys
--- PASS: TestValidateDotEnv_DuplicateKeys (0.00s)
=== RUN   TestValidateDotEnv_EmptyFile
--- PASS: TestValidateDotEnv_EmptyFile (0.00s)
=== RUN   TestValidateDotEnv_InlineComments
--- PASS: TestValidateDotEnv_InlineComments (0.00s)
=== RUN   TestValidateDotEnv_NoQuotesWhenRequired
--- PASS: TestValidateDotEnv_NoQuotesWhenRequired (0.00s)
=== RUN   TestValidateDotEnv_CustomPlugin
--- PASS: TestValidateDotEnv_CustomPlugin (0.00s)
=== RUN   TestValidateDotEnv_InvalidKeyValue
--- PASS: TestValidateDotEnv_InvalidKeyValue (0.00s)
=== RUN   TestValidateDotEnv_KeyNotHandledByAnyPlugin
--- PASS: TestValidateDotEnv_KeyNotHandledByAnyPlugin (0.00s)
PASS
ok      github.com/mwiater/go-validot   (cached)
?       github.com/mwiater/go-validot/examples/enum_validation  [no test files]
?       github.com/mwiater/go-validot/examples/ip_address_validation    [no test files]
?       github.com/mwiater/go-validot/examples/url_validation   [no test files]
?       github.com/mwiater/go-validot/plugins   [no test files]

Note: The exact timing (0.XXXs) will vary based on system performance.

Interpreting the Results

PASS Status:
Indicates that the test case has successfully passed without any issues.
FAIL Status:
Signifies that the test case encountered an error or did not meet the expected conditions. Review the error messages to identify and address the underlying issues.

By regularly running the test suite, you can ensure that go-validot remains reliable and continues to validate your .env files effectively as your project evolves.

For more information, contributions, or support, please refer to the GitHub repository.

Name		Name	Last commit message	Last commit date
Latest commit History 6 Commits
examples		examples
plugins		plugins
LICENSE		LICENSE
README.md		README.md
config.go		config.go
go.mod		go.mod
go.sum		go.sum
validot.go		validot.go
validot_test.go		validot_test.go

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

go-validot

Table of Contents

Features

Installation

Usage

Examples

Available Examples

Configuration

Example Configuration

Plugins

1. BooleanValidationPlugin

2. EnumValidationPlugin

3. IPAddressValidationPlugin

4. URLValidationPlugin

Creating Custom Plugins

Best Practices

Running the Tests

How to Run the Tests

Expected Output

Interpreting the Results

About

Releases

Packages

Languages

License

mwiater/go-validot

Folders and files

Latest commit

History

Repository files navigation

go-validot

Table of Contents

Features

Installation

Usage

Examples

Available Examples

Configuration

Example Configuration

Plugins

1. BooleanValidationPlugin

2. EnumValidationPlugin

3. IPAddressValidationPlugin

4. URLValidationPlugin

Creating Custom Plugins

Best Practices

Running the Tests

How to Run the Tests

Expected Output

Interpreting the Results

About

Topics

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages