From: Alexander Goussas Date: Fri, 26 Dec 2025 13:24:45 +0000 (-0500) Subject: initial commit X-Git-Url: http://git.frustrated-labs.net/?a=commitdiff_plain;h=f69d1d95bd43a41b447e29cd0929ab5d2a21182c;p=gradle-configvalidator-plugin.git initial commit --- f69d1d95bd43a41b447e29cd0929ab5d2a21182c diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..f91f646 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,12 @@ +# +# https://help.github.com/articles/dealing-with-line-endings/ +# +# Linux start script should use lf +/gradlew text eol=lf + +# These are Windows script files and should use crlf +*.bat text eol=crlf + +# Binary files should be left untouched +*.jar binary + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1c69b44 --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +# Ignore Gradle project-specific cache directory +.gradle + +# Ignore Gradle build output directory +build + +lib/src/test/resources/rules.yaml diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..7bc07ec --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,10 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ +# Environment-dependent path to Maven home directory +/mavenHomeManager.xml +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml diff --git a/.idea/compiler.xml b/.idea/compiler.xml new file mode 100644 index 0000000..b86273d --- /dev/null +++ b/.idea/compiler.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.idea/gradle.xml b/.idea/gradle.xml new file mode 100644 index 0000000..c27f474 --- /dev/null +++ b/.idea/gradle.xml @@ -0,0 +1,18 @@ + + + + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..7c47dd4 --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..377538c --- /dev/null +++ b/gradle.properties @@ -0,0 +1,5 @@ +# This file was generated by the Gradle 'init' task. +# https://docs.gradle.org/current/userguide/build_environment.html#sec:gradle_configuration_properties + +org.gradle.configuration-cache=true + diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml new file mode 100644 index 0000000..c88d35d --- /dev/null +++ b/gradle/libs.versions.toml @@ -0,0 +1,8 @@ +# This file was generated by the Gradle 'init' task. +# https://docs.gradle.org/current/userguide/platforms.html#sub::toml-dependencies-format + +[versions] +junit-jupiter = "5.12.1" + +[libraries] +junit-jupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "junit-jupiter" } diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..1b33c55 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..ff23a68 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.2-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..23d15a9 --- /dev/null +++ b/gradlew @@ -0,0 +1,251 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH="\\\"\\\"" + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..db3a6ac --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,94 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH= + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/lib/build.gradle.kts b/lib/build.gradle.kts new file mode 100644 index 0000000..0d96185 --- /dev/null +++ b/lib/build.gradle.kts @@ -0,0 +1,31 @@ +/* + * This file was generated by the Gradle 'init' task. + * + * This generated file contains a sample Java library project to get you started. + * For more details on building Java & JVM projects, please refer to https://docs.gradle.org/8.14.2/userguide/building_java_projects.html in the Gradle documentation. + */ + +plugins { + `java-library` +} + +repositories { + // Use Maven Central for resolving dependencies. + mavenCentral() +} + +dependencies { + implementation("org.yaml:snakeyaml:2.2") + testImplementation(libs.junit.jupiter) + testRuntimeOnly("org.junit.platform:junit-platform-launcher") +} + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(21) + } +} + +tasks.named("test") { + useJUnitPlatform() +} diff --git a/lib/src/main/java/io/github/aloussase/configvalidator/ConfigurationVariable.java b/lib/src/main/java/io/github/aloussase/configvalidator/ConfigurationVariable.java new file mode 100644 index 0000000..5ab41d8 --- /dev/null +++ b/lib/src/main/java/io/github/aloussase/configvalidator/ConfigurationVariable.java @@ -0,0 +1,7 @@ +package io.github.aloussase.configvalidator; + +public record ConfigurationVariable( + String name, + String value +) { +} diff --git a/lib/src/main/java/io/github/aloussase/configvalidator/ConfigurationVariableSource.java b/lib/src/main/java/io/github/aloussase/configvalidator/ConfigurationVariableSource.java new file mode 100644 index 0000000..e98ac25 --- /dev/null +++ b/lib/src/main/java/io/github/aloussase/configvalidator/ConfigurationVariableSource.java @@ -0,0 +1,13 @@ +package io.github.aloussase.configvalidator; + +import java.util.List; + +public interface ConfigurationVariableSource { + /** + * Read a list of configuration variables defined for the specified environment. + * + * @param env The environment for which to fetch configuration variables. + * @return A list of the configuration variables defined in the given environment. + */ + List readConfigurationVariables(String env); +} diff --git a/lib/src/main/java/io/github/aloussase/configvalidator/RuleEngine.java b/lib/src/main/java/io/github/aloussase/configvalidator/RuleEngine.java new file mode 100644 index 0000000..c06a35b --- /dev/null +++ b/lib/src/main/java/io/github/aloussase/configvalidator/RuleEngine.java @@ -0,0 +1,28 @@ +package io.github.aloussase.configvalidator; + +import io.github.aloussase.configvalidator.reporting.ResultsReporter; +import io.github.aloussase.configvalidator.rules.parser.RuleParser; + +public class RuleEngine { + + private final ResultsReporter resultsReporter; + private final RuleParser ruleParser; + private final ConfigurationVariableSource configurationVariableSource; + + public RuleEngine(ResultsReporter resultsReporter, RuleParser ruleParser, ConfigurationVariableSource configurationVariableSource) { + this.resultsReporter = resultsReporter; + this.ruleParser = ruleParser; + this.configurationVariableSource = configurationVariableSource; + } + + public void run(String rulesSource, String env) { + final var rules = ruleParser.parse(rulesSource); + final var configurationVariables = configurationVariableSource.readConfigurationVariables(env); + final var validationResults = configurationVariables + .stream() + .flatMap(cv -> rules.stream().map(r -> r.applyTo(cv))) + .toList(); + resultsReporter.report(validationResults); + } + +} diff --git a/lib/src/main/java/io/github/aloussase/configvalidator/Validation.java b/lib/src/main/java/io/github/aloussase/configvalidator/Validation.java new file mode 100644 index 0000000..b46516d --- /dev/null +++ b/lib/src/main/java/io/github/aloussase/configvalidator/Validation.java @@ -0,0 +1,49 @@ +package io.github.aloussase.configvalidator; + +import java.net.URI; +import java.net.URISyntaxException; +import java.util.function.Function; + +public sealed interface Validation permits Validation.Success, Validation.Error { + + static Function noLeadingWhitespace() { + return (ConfigurationVariable cv) -> { + if (cv.value().startsWith(" ")) { + return new Error(cv, "Unexpected whitespace at the start of " + cv.name()); + } else { + return new Success(); + } + }; + } + + static Function noTrailingWhitespace() { + return (ConfigurationVariable cv) -> { + if (cv.value().endsWith(" ")) { + return new Error(cv, "Unexpected whitespace at the end of " + cv.name()); + } else { + return new Success(); + } + }; + } + + static Function validUrl() { + return (ConfigurationVariable cv) -> { + try { + new URI(cv.value()); + return new Success(); + } catch (URISyntaxException | IllegalArgumentException ignored) { + return new Error(cv, "Invalid URL: " + cv.name()); + } + }; + } + + record Success() implements Validation { + } + + record Error( + ConfigurationVariable subject, + String message + ) implements Validation { + } + +} diff --git a/lib/src/main/java/io/github/aloussase/configvalidator/reporting/ResultsReporter.java b/lib/src/main/java/io/github/aloussase/configvalidator/reporting/ResultsReporter.java new file mode 100644 index 0000000..5f94be1 --- /dev/null +++ b/lib/src/main/java/io/github/aloussase/configvalidator/reporting/ResultsReporter.java @@ -0,0 +1,14 @@ +package io.github.aloussase.configvalidator.reporting; + +import io.github.aloussase.configvalidator.Validation; + +import java.util.List; + +public interface ResultsReporter { + /** + * Report the results of configuration variable configuration. + * + * @param validationResults The validation results to report. + */ + void report(List validationResults); +} diff --git a/lib/src/main/java/io/github/aloussase/configvalidator/rules/AbstractRuleFactory.java b/lib/src/main/java/io/github/aloussase/configvalidator/rules/AbstractRuleFactory.java new file mode 100644 index 0000000..6755c47 --- /dev/null +++ b/lib/src/main/java/io/github/aloussase/configvalidator/rules/AbstractRuleFactory.java @@ -0,0 +1,23 @@ +package io.github.aloussase.configvalidator.rules; + +import io.github.aloussase.configvalidator.Validation; + +public abstract class AbstractRuleFactory { + + /** + * Create a new Rule from the given selector and rule name. + * + * @param selector The selector for which the rule applies. + * @param name The name of the rule. + * @return A Rule. + */ + public static Rule create(String selector, String name) { + return switch (name) { + case "no-trailing-whitespace" -> Rule.mk(selector, Validation.noTrailingWhitespace()); + case "no-leading-whitespace" -> Rule.mk(selector, Validation.noLeadingWhitespace()); + case "valid-url" -> Rule.mk(selector, Validation.validUrl()); + default -> throw new IllegalArgumentException("Unknown rule name: " + name); + }; + } + +} diff --git a/lib/src/main/java/io/github/aloussase/configvalidator/rules/Rule.java b/lib/src/main/java/io/github/aloussase/configvalidator/rules/Rule.java new file mode 100644 index 0000000..bdcf76c --- /dev/null +++ b/lib/src/main/java/io/github/aloussase/configvalidator/rules/Rule.java @@ -0,0 +1,40 @@ +package io.github.aloussase.configvalidator.rules; + +import io.github.aloussase.configvalidator.ConfigurationVariable; +import io.github.aloussase.configvalidator.Validation; + +import java.util.function.Function; + +public abstract class Rule { + + protected String selector; + + public Rule(String selector) { + this.selector = selector; + } + + public static Rule mk(String selector, Function f) { + return new Rule(selector) { + @Override + protected Validation doApply(ConfigurationVariable subject) { + return f.apply(subject); + } + }; + } + + /** + * Apply this rule to a given ConfigurationVariable to get the resulting validation. + * + * @param subject The configuration variable to apply this Rule to + * @return The result of the validation + */ + public Validation applyTo(ConfigurationVariable subject) { + if ("default".equals(selector) || subject.name().equals(selector)) { + return doApply(subject); + } + // If the Rule does not apply, then there's nothing to validate. + return new Validation.Success(); + } + + protected abstract Validation doApply(ConfigurationVariable subject); +} diff --git a/lib/src/main/java/io/github/aloussase/configvalidator/rules/parser/RuleParser.java b/lib/src/main/java/io/github/aloussase/configvalidator/rules/parser/RuleParser.java new file mode 100644 index 0000000..0c6cb13 --- /dev/null +++ b/lib/src/main/java/io/github/aloussase/configvalidator/rules/parser/RuleParser.java @@ -0,0 +1,15 @@ +package io.github.aloussase.configvalidator.rules.parser; + +import io.github.aloussase.configvalidator.rules.Rule; + +import java.util.List; + +public interface RuleParser { + /** + * Parse a list of rules from a given string source. + * + * @param source The string from which to parse the rules. + * @return A list of Rules. + */ + List parse(String source); +} diff --git a/lib/src/main/java/io/github/aloussase/configvalidator/rules/parser/YamlRuleParser.java b/lib/src/main/java/io/github/aloussase/configvalidator/rules/parser/YamlRuleParser.java new file mode 100644 index 0000000..1e24420 --- /dev/null +++ b/lib/src/main/java/io/github/aloussase/configvalidator/rules/parser/YamlRuleParser.java @@ -0,0 +1,34 @@ +package io.github.aloussase.configvalidator.rules.parser; + +import io.github.aloussase.configvalidator.rules.AbstractRuleFactory; +import io.github.aloussase.configvalidator.rules.Rule; +import org.yaml.snakeyaml.Yaml; + +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class YamlRuleParser implements RuleParser { + private final Yaml yaml; + + public YamlRuleParser() { + this.yaml = new Yaml(); + } + + @Override + public List parse(String source) { + final Map map = yaml.load(source); + final Map configuredRules = (Map) map.get("rules"); + if (configuredRules == null) return new ArrayList<>(); + final List rules = new ArrayList<>(); + for (final var entry : configuredRules.entrySet()) { + final var selector = entry.getKey(); + final var entryRules = (List>) entry.getValue(); + for (final var entryRule : entryRules) { + final var ruleName = (String) entryRule.get("name"); + rules.add(AbstractRuleFactory.create(selector, ruleName)); + } + } + return rules; + } +} diff --git a/lib/src/test/java/io/github/aloussase/configvalidator/rules/AbstractRuleFactoryTest.java b/lib/src/test/java/io/github/aloussase/configvalidator/rules/AbstractRuleFactoryTest.java new file mode 100644 index 0000000..a75658c --- /dev/null +++ b/lib/src/test/java/io/github/aloussase/configvalidator/rules/AbstractRuleFactoryTest.java @@ -0,0 +1,66 @@ +package io.github.aloussase.configvalidator.rules; + +import io.github.aloussase.configvalidator.ConfigurationVariable; +import io.github.aloussase.configvalidator.Validation; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.Arguments; +import org.junit.jupiter.params.provider.MethodSource; + +import java.util.stream.Stream; + +import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertNotNull; + +public class AbstractRuleFactoryTest { + + static record TestCase( + String selector, + String ruleName, + ConfigurationVariable errorCase, + ConfigurationVariable successCase + ) { + } + + static Stream provideTestCases() { + return Stream.of( + Arguments.of( + new TestCase( + "default", + "no-leading-whitespace", + new ConfigurationVariable("test", " yo"), + new ConfigurationVariable("test", "yo") + ) + ), + Arguments.of( + new TestCase( + "default", + "no-trailing-whitespace", + new ConfigurationVariable("test", "yo "), + new ConfigurationVariable("test", "yo") + ) + ), + Arguments.of( + new TestCase( + "default", + "valid-url", + new ConfigurationVariable("test", "asfds fs"), + new ConfigurationVariable("test", "https://example.com") + ) + ) + ); + } + + @ParameterizedTest + @MethodSource("provideTestCases") + public void givenNoLeadingWhitespaceRuleNameWhenCreatingRuleThenResultingRuleWorksCorrectly(TestCase testCase) { + final var selector = testCase.selector(); + final var name = testCase.ruleName(); + + final var rule = AbstractRuleFactory.create(selector, name); + + assertNotNull(rule); + assertInstanceOf(Validation.Error.class, rule.applyTo(testCase.errorCase())); + assertInstanceOf(Validation.Success.class, rule.applyTo(testCase.successCase())); + } + +} \ No newline at end of file diff --git a/lib/src/test/java/io/github/aloussase/configvalidator/rules/parser/YamlRuleParserTests.java b/lib/src/test/java/io/github/aloussase/configvalidator/rules/parser/YamlRuleParserTests.java new file mode 100644 index 0000000..3986ab2 --- /dev/null +++ b/lib/src/test/java/io/github/aloussase/configvalidator/rules/parser/YamlRuleParserTests.java @@ -0,0 +1,43 @@ +package io.github.aloussase.configvalidator.rules.parser; + +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; + +public class YamlRuleParserTests { + + @Test + public void givenValidRulesSpecificationContainingOneRuleWhenParsingRulesThenResultHasThatOneRule() { + final var doc = "rules:\n default:\n - name: \"no-trailing-whitespace\""; + final var parser = new YamlRuleParser(); + + final var rules = parser.parse(doc); + + assertEquals(1, rules.size()); + assertNotNull(rules.getFirst()); + } + + @Test + public void givenValidRulesSpecificationWithTwoRulesWhenParsingRulesThenResultHasTwoRules() { + final var doc = "rules:\n default:\n - name: \"no-trailing-whitespace\"\n - name: \"no-leading-whitespace\""; + final var parser = new YamlRuleParser(); + + final var rules = parser.parse(doc); + + assertEquals(2, rules.size()); + assertNotNull(rules.getFirst()); + } + + @Test + public void givenValidRulesSpecificationWithTwoSelectorWithOneRuleEachWhenParsingRulesThenResultHasTwoRules() { + final var doc = "rules:\n default:\n - name: \"no-trailing-whitespace\"\n go_points_checkout_url:\n - name: \"valid-url\""; + final var parser = new YamlRuleParser(); + + final var rules = parser.parse(doc); + + assertEquals(2, rules.size()); + assertNotNull(rules.getFirst()); + } + +} diff --git a/lib/src/test/resources/sample-rules.yaml b/lib/src/test/resources/sample-rules.yaml new file mode 100644 index 0000000..af829a6 --- /dev/null +++ b/lib/src/test/resources/sample-rules.yaml @@ -0,0 +1,6 @@ +rules: + default: + - name: "no-trailing-whitespace" + - name: "no-leading-whitespace" + go_points_checkout_url: + - name: "valid-url" \ No newline at end of file diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..38ac628 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,14 @@ +/* + * This file was generated by the Gradle 'init' task. + * + * The settings file is used to specify which projects to include in your build. + * For more detailed information on multi-project builds, please refer to https://docs.gradle.org/8.14.2/userguide/multi_project_builds.html in the Gradle documentation. + */ + +plugins { + // Apply the foojay-resolver plugin to allow automatic download of JDKs + id("org.gradle.toolchains.foojay-resolver-convention") version "0.10.0" +} + +rootProject.name = "configvalidator" +include("lib")