Validate benchmark name in createBenchmark.sh script

[korthout]

Description

The create benchmark script uses the benchmark name among others for the
k8s namespace. However, k8s does not accept dots in the namespace. I
found this out after fully building Zeebe and the docker images locally,
which takes a few minutes. We can simply check for this at the start of
the script to fail early and help users of the script with such
mistakes.

Related issues

NA

Definition of Done

Not all items need to be done depending on the issue and the pull request.

Code changes:

• The changes are backwards compatibility with previous versions
• If it fixes a bug then PRs are created to backport the fix to the last two minor versions. You can trigger a backport by assigning labels (e.g. backport stable/0.25) to the PR, in case that fails you need to create backports manually.

Testing:

• There are unit/integration tests that verify all acceptance criterias of the issue
• New tests are written to ensure backwards compatibility with further versions
• The behavior is tested manually
• The change has been verified by a QA run
• The impact of the changes is verified by a benchmark

Documentation:

• The documentation is updated (e.g. BPMN reference, configuration, examples, get-started guides, etc.)
• New content is added to the release announcement

[Zelldon]

Hey @korthout thanks I also ran into this multiple times. I think it make sense to use the real regex here.

So the k8 docs says https://kubernetes.io/docs/concepts/overview/working-with-objects/names/

RFC 1123 Label Names
Some resource types require their names to follow the DNS label standard as defined in RFC 1123. This means the name must:

contain at most 63 characters
contain only lowercase alphanumeric characters or '-'
start with an alphanumeric character
end with an alphanumeric character

Found on SO that if you use a wrong namespace kubectl will tell you which regex they use

$ k create ns not-valid1234234$%
The Namespace "not-valid1234234$%" is invalid: metadata.name: Invalid value: "not-valid1234234$%": a lowercase RFC 1123 label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character (e.g. 'my-name',  or '123-abc', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?')

Based on that and some other posts

I end with this: ^[a-z0-9]([-a-z0-9]*[a-z0-9]){,63}$

Tests:

[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ if [[ test =~ ^[a-z0-9]([-a-z0-9]*[a-z0-9]){,63}$ ]] ; then echo "valid"; fi
valid
[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ if [[ test.test =~ ^[a-z0-9]([-a-z0-9]*[a-z0-9]){,63}$ ]] ; then echo "valid"; fi
[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ if [[ test-test =~ ^[a-z0-9]([-a-z0-9]*[a-z0-9]){,63}$ ]] ; then echo "valid"; fi
valid
[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ if [[ tes123t-test =~ ^[a-z0-9]([-a-z0-9]*[a-z0-9]){,63}$ ]] ; then echo "valid"; fi
valid
[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ if [[ tes123.t-test =~ ^[a-z0-9]([-a-z0-9]*[a-z0-9]){,63}$ ]] ; then echo "valid"; fi

So my suggestion would be to use that regex to match the benchmark name. :)

[Zelldon]

Sorry the first one was not complete (or allowed to many characters):

New one: ^[a-z0-9]([-a-z0-9]{,61}[a-z0-9])?$

[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ test=123456789-123456789-123456789-123456789-123456789-123456789-123
[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ if [[ $test =~ ^[a-z0-9]([-a-z0-9]{,61}[a-z0-9])?$ ]] ; then echo "valid"; fi
valid


[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ test=123456789-123456789-123456789-123456789-123456789-123456789-1234
[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ if [[ $test =~ ^[a-z0-9]([-a-z0-9]{,61}[a-z0-9])?$ ]] ; then echo "valid"; fi


[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ test=123456789-123456789-123456789-123456789-123456789-123456789-12-
[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ if [[ $test =~ ^[a-z0-9]([-a-z0-9]{,61}[a-z0-9])?$ ]] ; then echo "valid"; fi


[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ test=123456789-123456789-123456789-123456789-123456789-123456789-12A
[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ if [[ $test =~ ^[a-z0-9]([-a-z0-9]{,61}[a-z0-9])?$ ]] ; then echo "valid"; fi


[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ test=123456789-123456789-123456789-123456789-123456789-123456789-12
[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ if [[ $test =~ ^[a-z0-9]([-a-z0-9]{,61}[a-z0-9])?$ ]] ; then echo "valid"; fi
valid


[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ test=123456789-123456789-123456789-123456789-123456789-123456789-1.2
[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ if [[ $test =~ ^[a-z0-9]([-a-z0-9]{,61}[a-z0-9])?$ ]] ; then echo "valid"; fi


[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ test=2
[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ if [[ $test =~ ^[a-z0-9]([-a-z0-9]{,61}[a-z0-9])?$ ]] ; then echo "valid"; fi
valid


[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ test=-
[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ if [[ $test =~ ^[a-z0-9]([-a-z0-9]{,61}[a-z0-9])?$ ]] ; then echo "valid"; fi


[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ test=2-
[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ if [[ $test =~ ^[a-z0-9]([-a-z0-9]{,61}[a-z0-9])?$ ]] ; then echo "valid"; fi


[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ test=2-2
[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ if [[ $test =~ ^[a-z0-9]([-a-z0-9]{,61}[a-z0-9])?$ ]] ; then echo "valid"; fi
valid


[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ test=22
[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ if [[ $test =~ ^[a-z0-9]([-a-z0-9]{,61}[a-z0-9])?$ ]] ; then echo "valid"; fi
valid


[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ test=2.2
[zell ~/ cluster: zeebe-cluster ns:zell-st-gw-v3]$ if [[ $test =~ ^[a-z0-9]([-a-z0-9]{,61}[a-z0-9])?$ ]] ; then echo "valid"; fi

[korthout]

Tested manually:

./createBenchmark.sh
<benchmark-name> not provided

Usage ./createBenchmark <benchmark-name>

----

./createBenchmark.sh a
<benchmark-name> 'a' not a valid DNS label
See https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names

Usage ./createBenchmark <benchmark-name>

----

./createBenchmark.sh release-1.3.0
<benchmark-name> 'release-1.3.0' not a valid DNS label
See https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names

Usage ./createBenchmark <benchmark-name>

----

./createBenchmark.sh release-1-3-0
+ mvn clean install -DskipTests -T1C
[INFO] Scanning for projects...

[Zelldon]

Specific reason why not using ^[a-z0-9]([-a-z0-9]{,61}[a-z0-9])?$? Single letters are normally allowed.

[korthout]

It forced a - to be present for anything longer than 1 character

[korthout]

But that's interesting. We can rework it to also allow 1 char

[Zelldon]

It forced a - to be present for anything longer than 1 character

Not sure what you mean but above you can see in my tests #8455 (comment) it worked also for 22

[korthout]

Hmm perhaps I had my test wrong. I'll have another look tomorrow :D

[korthout]

I checked among many others ab is not accepted by ^[a-z0-9]([-a-z0-9]{,61}[a-z0-9])?$ see https://regex101.com/r/vjsrEy/1

We can use ^[a-z0-9]([-a-z0-9]{0,61}[a-z0-9])?$ see https://regex101.com/r/vjsrEy/2 🎉

[Zelldon]

Thanks @korthout 💟 🎖️

bors r+

[ghost]

Build succeeded:

• continuous-integration/jenkins/branch
• Run smoke tests on macos-latest
• Run smoke tests on ubuntu-latest
• Run smoke tests on windows-latest