test: Add tests for file_header and footer

[Maleware]

Description

adds tests as a follow up to #530

Definition of Done Checklist

• Not all of these items are applicable to all PRs, the author should update this template to only leave the boxes in that are relevant
• Please make sure all these things are done and tick the boxes

Author

Preview Give feedback

1. Changes are OpenShift compatible
2. CRD changes approved
3. CRD documentation for all fields, following the style guide.
4. Helm chart can be installed and deployed operator works
5. Integration tests passed (for non trivial changes)
6. Changes need to be "offline" compatible

Reviewer

Preview Give feedback

1. Code contains useful comments
2. Code contains useful logging statements
3. (Integration-)Test cases added
4. Documentation added or updated. Follows the style guide.
5. Changelog updated
6. Cargo.toml only contains references to git tags (not specific commits or branches)

Acceptance

Preview Give feedback

1. Feature Tracker has been updated
2. Proper release label has been added
3. Roadmap has been updated

[NickLarsenNZ]

Will paste a suggestion shortly

[NickLarsenNZ]

I think this should be simplified. Will paste an example in a moment.

[NickLarsenNZ]

• Convert to multi-line for readability.
• Remove long inline command from if [ .. ].
• Refer to superset_config.py inside [] instead of dotting it.
• Use single quotes so we don't need to escape double quotes.
• Removed the subshell () and braces {} from the then/else blocks.
• Redirect failure message to STDERR.

Suggested change

	if [ -z "$(kubectl -n $NAMESPACE get cm superset-node-default -o yaml | yq -e '.data."superset_config.py"' | grep "ROLE_HEADER_VAR = \"role-value\"")" ]; then (echo "Success, ROLE_HEADER_VAR not present") else { echo "Failure, ROLE_HEADER_VAR present"; exit 1; } fi
	RESULT=$(
	kubectl -n $NAMESPACE get cm superset-node-default -o yaml \
	| yq -e '.data["superset_config.py"]' \
	| grep 'ROLE_HEADER_VAR = "role-value"'
	)
	if [ -z "$RESULT" ]; then
	echo "Success, ROLE_HEADER_VAR not present"
	else
	2>& echo "Failure, ROLE_HEADER_VAR present"
	exit 1
	fi

[NickLarsenNZ]

I actually think the whole if block could be simplified by using grep -v so the test looks more like the others.

[NickLarsenNZ]

I will post a separate comment with what I suggest the whole script should look like.

See: #533 (comment)

[NickLarsenNZ]

I have added my suggestion to make the whole test script more readable (I couldn't add Github suggestions as there were unchanged lines that I can't select).

[NickLarsenNZ]

Here's my suggestion:

• Use bash and with strict mode (so failures before the last command cause the script to fail).
• Reduce calls to kubectl for the same resources.
• Simplify the assertions.
• Use single quotes for strings which don't need variable expansion.
• Template the yq filter (unfortunately the go yq works so much differently to the python one which works basically the same as jq... so there are no --arg options).

# - script: |
      #!/usr/bin/env bash
      set -euo pipefail

      # Config Test Data
      SUPERSET_CONFIG=$(
          kubectl -n "$NAMESPACE" get cm superset-node-default -o yaml \
          | yq -e '.data["superset_config.py"]'
      )

      # Config Test Assertions
      echo "$SUPERSET_CONFIG" | grep 'COMMON_HEADER_VAR = "group-value"'
      echo "$SUPERSET_CONFIG" | grep 'ROLE_FOOTER_VAR = "role-value"'
      echo "$SUPERSET_CONFIG" | grep -v 'ROLE_HEADER_VAR = "role-value"'
      
      # STS Spec Test Data
      SUPERSET_NODE_DEFAULT_STS=$(kubectl -n "$NAMESPACE" get sts superset-node-default -o yaml)
      YQ_FILTER='
        .spec.template.spec.containers[]
        | select(.name == "superset") 
        | .env[] 
        | select(.name == strenv(KEY) and .value == strenv(VALUE))
      '

      # STS Spec Test Assertions
      echo "$SUPERSET_NODE_DEFAULT_STS" | KEY="COMMON_VAR" VALUE="group-value" yq -e "$YQ_FILTER"
      echo "$SUPERSET_NODE_DEFAULT_STS" | KEY="GROUP_VAR" VALUE="group-value" yq -e "$YQ_FILTER"
      echo "$SUPERSET_NODE_DEFAULT_STS" | KEY="ROLE_VAR" VALUE="role-value" yq -e "$YQ_FILTER"

[Maleware]

Thank you for the suggestion, it makes sense to me. However, we implemented such stuff here e.g. https://github.com/stackabletech/airflow-operator/pull/490/files and from myself https://github.com/stackabletech/airflow-operator/pull/493/files

As I said I like your suggestion, but fear our tests differ to much from one another and nobody is going to understand it anymore

[NickLarsenNZ]

I see how it has been done, but to me they are unreadable. I think we should go with the readable option (it lessens the burden on reviewers too).

[sbernauer]

First off: I don't have a strong opinion, but I would tend to agree with @NickLarsenNZ. I see your concerns @Maleware and I have the same ones (mono-repo would be much easier here), but I personally think readability is more important in this case (especially as @NickLarsenNZ already did the work of rewriting the script)

[Maleware]

Granted: ca1e726

[sbernauer]

LGTM