Add some basic unit tests and update CI workflow #218

d3adb5 · 2023-02-05T02:34:41Z

Hi there! Noticed you guys were using the GitHub action I wrote for running Helm
template unit tests, and decided to come check out your repository. I noticed
the test suite added by @TehreemNisa in #214 wasn't actually running due to the
filename used, and decided to fix that.

I realize this is a somewhat large first PR, but I figured it was worth adding
some unit tests and refactoring some of the existing templates to improve
readability and maintainability.

The CI workflow was updated to use v2 of my unit test action. This version
points to the now official repository, taken over by the plugin maintainer.

Here is a breakdown of the changes, as a list of commits:

chore: set chart api version to v2
docs: point chart home to correct repo
test: fix deployment test so it's run & passing
ci: update to helm-unittest action v2
test: add unit tests for horizontal autoscaler
refactor(hpa): use deployment.enabled in tpl conditional
refactor(hpa): use autoscaling/v2 when available
refactor(hpa): adjust indentation and whitespace
test: add unit tests for service acc template
refactor(sa): adjust indentation, spacing, lines
test: add unit tests for pvc template
test: add unit tests for pdb template
refactor(pdb): adjust indentation and whitespace

If this pull request is accepted and merged, I'd be happy to implement more unit
tests and improve readability for the chart overall.

stakater-user · 2023-02-05T02:35:08Z

@d3adb5 Yikes! You better fix it before anyone else finds out! Build has Failed!

d3adb5 · 2023-02-05T02:39:31Z

I imagine the build failing has something to do with me not having access to repository / organization secrets. As for the unit test job, while it claims to be passing, the logs suggest my changes to the workflow weren't applied for this run, since it still uses v1 of d3adb5/helm-unittest-action, and shows no test suite being executed.

rasheedamir · 2023-03-13T21:40:59Z

thank you @d3adb5 for such a thorough PR! we are fixing the pipelines runtime and then we would really appreciate more PRs which can improve the readability of the chart and have more unit tests; we are also thinking to add integration tests

d3adb5 · 2023-03-14T03:38:40Z

thank you @d3adb5 for such a thorough PR! we are fixing the pipelines runtime and then we would really appreciate more PRs which can improve the readability of the chart and have more unit tests; we are also thinking to add integration tests

Sure thing! I'd be happy to do some refactoring and security touch ups soon! Do you guys know what's going on with the CI builds, @rasheedamir? Maybe I could help with that effort.

rasheedamir · 2023-03-24T18:18:19Z

@d3adb5 the pipelines are fixed now! can you please update this PR or create new one? now we are using self hosted github runners on full blown openshift cluster to ensure stuff works

d3adb5 · 2023-03-24T20:08:26Z

Seems like plenty changed in the repository. Well, I rebased my changes and hopefully everything's working fine. A careful review would be much appreciated! Thanks, @rasheedamir.

github-actions · 2023-03-24T20:09:14Z

@d3adb5 validation successful`

rasheedamir · 2023-03-31T14:48:45Z

@slauger @aslafy-z can you please review it

aslafy-z

LGTM, thank you @d3adb5 ! Please fix conflicts so we it can land asap :)

application/templates/pdb.yaml

Set the API version to v2 in Chart.yaml, as Helm v2 should no longer be supported, considering its EOL was November of 2020. Users of Helm v2 should update to Helm v3, as security patches are no longer released.

Change the URL to the correct repository in Chart.yaml.

Fix the test suite for the Deployment template so that it is actually executed by helm-unittest and does not rely on default chart values.

Update to v2 of d3adb5/helm-unittest-action for running tests with the latest version of helm-unittest.

Add unit tests for the HorizontalPodAutoscaler template.

Use the value of deployment.enabled instead of simply deployment in the condition for rendering the HorizontalPodAutoscaler template.

Use the autoscaling/v2 API version when it is advertised as available by the Kubernetes cluster the release is being deployed to.

Adjust indentation, whitespace gobbling, and trailing whitespace in the HorizontalPodAutoscaler template. The 'with' keyword was used to avoid repetition when referencing values, as well.

Add unit tests for the ServiceAccount template.

Adjust indentation, spacing, and line lengths for the ServiceAccount template. A partial template was added to both shorten and make more manageable the JSON passed to OpenShift as an annotation.

Add unit tests for the PersistentVolumeClaim template.

Add unit tests for the PodDisruptionBudget template.

Adjust indentation, whitespace, and minor templating on the Go template side to improve readability for the PodDisruptionBudget template.

d3adb5 · 2023-03-31T22:29:25Z

@aslafy-z Conflicts resolved! Turns out #221 did what one of my previous commits was doing. I changed my unit tests and commit messages accordingly.

aslafy-z

LGTM 🙏

aslafy-z · 2023-03-31T22:57:01Z

application/templates/hpa.yaml

-{{ if .Capabilities.APIVersions.Has "autoscaling/v2/HorizontalPodAutoscaler" -}}
+{{- if and .Values.autoscaling.enabled .Values.deployment.enabled }}
+
+{{- if .Capabilities.APIVersions.Has "autoscaling/v2/HorizontalPodAutoscaler" }}


Thank you for updating these check to GVK instead of GV. I'm deploying most of my apps with ArgoCD and had lot of pain previously with charts not comparing with the full GVK. See argoproj/argo-cd#7291

You can thank the person behind #221 for that instead! I was originally using GV. 👀

d3adb5 · 2023-04-01T00:50:39Z

Is it okay to merge this, @rasheedamir?

rasheedamir requested a review from AsfaMumtaz February 5, 2023 18:11

d3adb5 force-pushed the test/add-basic-unit-tests branch from 4e430df to 2c41d7a Compare March 24, 2023 20:06

rasheedamir requested review from aslafy-z and slauger March 31, 2023 14:48

aslafy-z previously approved these changes Mar 31, 2023

View reviewed changes

application/templates/pdb.yaml Show resolved Hide resolved

d3adb5 added 13 commits March 31, 2023 15:20

chore: set chart api version to v2

a9c68aa

Set the API version to v2 in Chart.yaml, as Helm v2 should no longer be supported, considering its EOL was November of 2020. Users of Helm v2 should update to Helm v3, as security patches are no longer released.

docs: point chart home to correct repo

1a9faa0

Change the URL to the correct repository in Chart.yaml.

test: fix deployment test so it's run & passing

3cfc9e5

Fix the test suite for the Deployment template so that it is actually executed by helm-unittest and does not rely on default chart values.

ci: update to helm-unittest action v2

4e02cf3

Update to v2 of d3adb5/helm-unittest-action for running tests with the latest version of helm-unittest.

test: add unit tests for horizontal autoscaler

54dfd82

Add unit tests for the HorizontalPodAutoscaler template.

refactor(hpa): use deployment.enabled in tpl conditional

f2baabc

Use the value of deployment.enabled instead of simply deployment in the condition for rendering the HorizontalPodAutoscaler template.

test(hpa): use autoscaling/v2 when available

cce9af4

Use the autoscaling/v2 API version when it is advertised as available by the Kubernetes cluster the release is being deployed to.

refactor(hpa): adjust indentation and whitespace

bbec82f

Adjust indentation, whitespace gobbling, and trailing whitespace in the HorizontalPodAutoscaler template. The 'with' keyword was used to avoid repetition when referencing values, as well.

test: add unit tests for service acc template

be3746d

Add unit tests for the ServiceAccount template.

refactor(sa): adjust indentation, spacing, lines

43c22a2

Adjust indentation, spacing, and line lengths for the ServiceAccount template. A partial template was added to both shorten and make more manageable the JSON passed to OpenShift as an annotation.

test: add unit tests for pvc template

2a40f89

Add unit tests for the PersistentVolumeClaim template.

test: add unit tests for pdb template

640e768

Add unit tests for the PodDisruptionBudget template.

refactor(pdb): adjust indentation and whitespace

e039f61

Adjust indentation, whitespace, and minor templating on the Go template side to improve readability for the PodDisruptionBudget template.

d3adb5 dismissed aslafy-z’s stale review via e039f61 March 31, 2023 22:26

d3adb5 force-pushed the test/add-basic-unit-tests branch from 2c41d7a to e039f61 Compare March 31, 2023 22:26

aslafy-z approved these changes Mar 31, 2023

View reviewed changes

rasheedamir merged commit 022cfa3 into stakater:master Apr 1, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add some basic unit tests and update CI workflow #218

Add some basic unit tests and update CI workflow #218

d3adb5 commented Feb 5, 2023 •

edited

Loading

stakater-user commented Feb 5, 2023

d3adb5 commented Feb 5, 2023

rasheedamir commented Mar 13, 2023

d3adb5 commented Mar 14, 2023

rasheedamir commented Mar 24, 2023

d3adb5 commented Mar 24, 2023

github-actions bot commented Mar 24, 2023

rasheedamir commented Mar 31, 2023

aslafy-z left a comment •

edited

Loading

d3adb5 commented Mar 31, 2023

aslafy-z left a comment

aslafy-z Mar 31, 2023 •

edited

Loading

d3adb5 Apr 1, 2023

d3adb5 commented Apr 1, 2023

Add some basic unit tests and update CI workflow #218

Add some basic unit tests and update CI workflow #218

Conversation

d3adb5 commented Feb 5, 2023 • edited Loading

stakater-user commented Feb 5, 2023

d3adb5 commented Feb 5, 2023

rasheedamir commented Mar 13, 2023

d3adb5 commented Mar 14, 2023

rasheedamir commented Mar 24, 2023

d3adb5 commented Mar 24, 2023

github-actions bot commented Mar 24, 2023

rasheedamir commented Mar 31, 2023

aslafy-z left a comment • edited Loading

Choose a reason for hiding this comment

d3adb5 commented Mar 31, 2023

aslafy-z left a comment

Choose a reason for hiding this comment

aslafy-z Mar 31, 2023 • edited Loading

Choose a reason for hiding this comment

d3adb5 Apr 1, 2023

Choose a reason for hiding this comment

d3adb5 commented Apr 1, 2023

d3adb5 commented Feb 5, 2023 •

edited

Loading

aslafy-z left a comment •

edited

Loading

aslafy-z Mar 31, 2023 •

edited

Loading