feat(config/validation): validate options which support regex/glob matching

[RahulGautamSingh]

Changes

• Add new fields patternMatch to the config options, which will be used to identify options which support regex/glob matching
• Refactor validation logic
• Add validation for options which support regex/Glob matching. This validation logic ensures that the options do not contain * or ** values along with other values.

Example: (these are not ok)

 "matchRepositories": ["*", "!abc/def"]
  "matchRepositories": ["*", "x/y", "!abc/def"]
  "matchRepositories": ["*", "x/y"]
  "matchRepositories": ["*", "**"]

Context

Closes: #28554

Documentation (please check one with an [x])

• I have updated the documentation, or
• No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

• Code inspection only, or
• Newly added/modified unit tests, or
• No unit tests but ran on a real repository, or
• Both unit tests + ran on a real repository

[HonkingGoose]

This new field needs to be explained in the docs. Right now it only shows the field in the config options table.

[RahulGautamSingh]

This new field needs to be explained in the docs. Right now it only shows the field in the config options table.

What place should this be added to?

[secustor]

This new field needs to be explained in the docs. Right now it only shows the field in the config options table.

This is not exposed to users, but rather for internal use to identify options which support the pattern matching feature.

Later this can be used to automatically link from these user exposed options to our "pattern matching" docs

[RahulGautamSingh]

The docs part needs to have some discussion so I will keep this option only for internal use in context of the issue this is PR is related to.

[rarkins]

Needs validation added

[viceice]

otherwise lgtm

[rarkins]

Can we combine this with other checks that validate the regex is ok?

[RahulGautamSingh]

Can we combine this with other checks that validate the regex is ok?

We have two checks for regex.

1. isRegexMatch combined with getRegexPredicate, which is used to validation the regex for options of type:string
2. matchRegexOrGlobList which is used to check whether theenv key names & hostRules.headers set in repo config match the patterns present in allowedEnv & allowedHeaders from the admin config resp.

For check(1), there isn't any way to combine as it only checks for regex validation only, no glob matching and it is designed for single string rather than an array

For check(2), we could make it work if we modify fn to include an if-check for the * or ** logic and expand the return types, to include an extra field say errMsg which we can use to know about the error.

For eg.
Currently the matchRegexOrGlobList fn returns a boolean

renovate/lib/util/string-match.ts

Lines 26 to 29 in ca23445

	export function matchRegexOrGlobList(
	input: string,
	patterns: string[],
	): boolean {

true: if the key is matches the patterns
false: if no match is found or patterns list is empty

New return types:

export function matchRegexOrGlobList(
  input: string,
  patterns: string[],
  currentPath?: string,
): { res: boolean; errMsg?: string } 

Incase we encounter an error say no matc found or * or ** string combined with other patterns, we pass it using the errMsg field and it can be then used in the validation logic.

[rarkins]

@RahulGautamSingh I pushed my suggested change to this branch - wdyt?

[RahulGautamSingh]

@RahulGautamSingh I pushed my suggested change to this branch - wdyt?

Looks good. I had misunderstood your ask a fair bit :)

[renovate-release]

🎉 This PR is included in version 37.341.0 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)
• 37.341.0

Your semantic-release bot 📦🚀