Enable Golang-based Integration Tests #590

v0lkan · 2024-03-04T02:08:10Z

Enable Golang-based Integration Tests

Description

This PR introduced Golang-based integration tests for more modularity and ease of management of VSecM integration test suites.

There is also considerable refactoring that I’ll annotate in the source code.

Behavior should not have changed.

Test Policy Compliance

I have added or updated unit tests for my changes.
I have included integration tests where applicable.
All new and existing tests pass successfully.

Code Quality

I have followed the coding standards for this project.
I have performed a self-review of my code.
My code is well-commented, particularly in areas that may be difficult
to understand.

Documentation

I have made corresponding changes to the documentation (if applicable).
I have updated any relevant READMEs or wiki pages.

Additional Comments

Include any additional comments or context about the PR here.

Checklist

Before you submit this PR, please make sure:

You have read the contributing guidelines and
especially the test policy.
You have thoroughly tested your changes.
You have followed all the contributing guidelines for this project.
You understand and agree that your contributions will be publicly available
under the project’s license.

By submitting this pull request, you confirm that my contribution is made under
the terms of the project’s license and that you have the authority to grant
these rights.

Thank you for your contribution to VMware Secrets Manager
🐢⚡️!

rewrite integration tests in go instead of bash Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

vmwclabot · 2024-03-04T02:08:13Z

@v0lkan, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 2b54511 must be signed by ovolkan@vmware.com

.github/pull-request-template.md

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

vmwclabot · 2024-03-04T02:14:34Z

@v0lkan, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 2b54511 must be signed by ovolkan@vmware.com

v0lkan · 2024-03-04T02:15:19Z

app/keygen/cmd/decrypt.go

- fmt.Println("Algorithm:", algorithm)
- fmt.Println("---")
+ println("Algorithm:", algorithm)
+ println("---")


using the simpler println() equivalent instead of fmt.Println() — I see this as go inspiring from Rust, and I like it.

v0lkan · 2024-03-04T02:16:03Z

app/safe/internal/bootstrap/k8s.go

+// ValidateEnvironment checks the application's runtime environment for essential
+// configuration settings, particularly focusing on the presence of the
+// 'VSECM_SYSTEM_NAMESPACE' environment variable. This variable is expected to
+// define the Kubernetes namespace in which the application is running, which is
+// crucial for the application's proper operation within a Kubernetes cluster.


Added a lot of documentation to public methods.

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

vmwclabot · 2024-03-04T02:19:46Z

@v0lkan, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 2b54511 must be signed by ovolkan@vmware.com

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

vmwclabot · 2024-03-04T03:01:29Z

@v0lkan, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 2b54511 must be signed by ovolkan@vmware.com

v0lkan · 2024-03-04T03:02:35Z

app/safe/internal/state/secret/populate.go

+ continue
+ }
+
+ secretOnDisk, err := persistence.ReadFromDisk(key, rootKeyTriplet)


I don’t like passing root key triplet like this… I had to do it to fix a circular dependency; will create a follow-up PR to make the function signature cleaner.

v0lkan · 2024-03-04T03:05:01Z

app/safe/internal/state/stats/stats.go

@@ -35,36 +40,36 @@ var currentState = Status{

 // Increment is a method for the Status struct that increments the NumSecrets
 // field by 1 if the provided secret name is not found in the in-memory store.
-func (s *Status) Increment(name string) {
+func (s *Status) Increment(name string, loader func(name any) (any, bool)) {


Also, Passing loader as an argument is not the best way to do this.

That’s also to fix circular dependency. — Will clean it up in a more targeted PR.

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

vmwclabot · 2024-03-04T03:06:23Z

@v0lkan, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 2b54511 must be signed by ovolkan@vmware.com

v0lkan · 2024-03-04T03:07:43Z

ci/test/assert/assert.go

+ // Count how many times 'Running' appears in the command output.
+ podCount := strings.Count(cmdOutput, "Running")


Man! This is “way” easier to do it in bash!.
And it is more readable and expressive too.

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

vmwclabot · 2024-03-04T03:08:56Z

@v0lkan, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 2b54511 must be signed by ovolkan@vmware.com

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

vmwclabot · 2024-03-04T03:10:10Z

@v0lkan, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 2b54511 must be signed by ovolkan@vmware.com

v0lkan · 2024-03-04T03:10:45Z

ci/test/io/io.go

+
+// WaitForExampleWorkload is a placeholder for the workload readiness check.
+// Placeholder for the workload readiness check. Replace this with your actual readiness check logic.
+func Wait(seconds time.Duration) error {


these are wrappers around bash fns.

v0lkan · 2024-03-04T03:11:27Z

ci/test/run.go

+ tryAll(
+ eval.SecretEncryption,
+ state.Cleanup,
+ deploy.WorkloadUsingSDK,
+ eval.SecretRegistration,
+ eval.SecretDeletion,
+ eval.SecretRegistrationAppend,
+ eval.SecretRegistrationJSONFormat,
+ eval.SecretRegistrationYAMLFormat,
+ state.Cleanup,
+ deploy.WorkloadUsingSidecar,
+ eval.SecretRegistrationSidecar,
+ eval.SecretDeletionSidecar,
+ eval.SecretRegistrationAppendSidecar,
+ eval.SecretRegistrationJSONFormatSidecar,
+ eval.SecretRegistrationYAMLFormatSidecar,
+ state.Cleanup,
+ eval.InitContainer,
+ state.Cleanup,


This way, it’s easy to add/remove comment out individual tests.

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

vmwclabot · 2024-03-04T03:14:24Z

@v0lkan, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 2b54511 must be signed by ovolkan@vmware.com

v0lkan · 2024-03-04T03:15:15Z

dockerfiles/example/init-container.Dockerfile

 # >/' SPDX-License-Identifier: BSD-2-Clause
 # */

 # builder image
-FROM golang:1.20.1-alpine3.17 as builder
+FROM golang:1.22.0-alpine3.19 as builder


Update the golang version.

v0lkan added 14 commits March 3, 2024 01:14

🌟 enhancement(VSecM): convert bash tests to go

93cb73e

rewrite integration tests in go instead of bash Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

fix sentinel attestation

1260433

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

Hadooken 🤾‍♂️🔥

924ef67

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

remove circular depdenceny

a5e9bf4

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

changes

2b54511

tests

1bda215

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

transformation fix

1b00105

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

fix

976dd7c

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

changes

ee1b85f

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

minor

2f234c7

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

pass

6e5abbc

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

cosmetic

8c61443

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

test update

bbfea38

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

tests

c601281

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

v0lkan requested a review from farhan-pasha as a code owner March 4, 2024 02:08

vmwclabot added the dco-required label Mar 4, 2024

v0lkan commented Mar 4, 2024

View reviewed changes

.github/pull-request-template.md Show resolved Hide resolved

missing EOL

62b4c87

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

v0lkan commented Mar 4, 2024

View reviewed changes

update changelog

54fb160

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

cleanup

5e82d45

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

v0lkan commented Mar 4, 2024

View reviewed changes

fix wording

61707fa

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

v0lkan commented Mar 4, 2024

View reviewed changes

wording change.

63c4300

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

minor

f9c3839

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

v0lkan commented Mar 4, 2024

View reviewed changes

changelog update

a92fd07

Signed-off-by: Volkan Özçelik <ovolkan@vmware.com>

v0lkan commented Mar 4, 2024

View reviewed changes

v0lkan merged commit b3977ec into main Mar 4, 2024

v0lkan deleted the ovolkan/test-refactor branch March 4, 2024 03:17

v0lkan removed the dco-required label Mar 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable Golang-based Integration Tests #590

Enable Golang-based Integration Tests #590

v0lkan commented Mar 4, 2024

vmwclabot commented Mar 4, 2024

vmwclabot commented Mar 4, 2024

v0lkan Mar 4, 2024

v0lkan Mar 4, 2024

vmwclabot commented Mar 4, 2024

vmwclabot commented Mar 4, 2024

v0lkan Mar 4, 2024

v0lkan Mar 4, 2024

vmwclabot commented Mar 4, 2024

v0lkan Mar 4, 2024

vmwclabot commented Mar 4, 2024

vmwclabot commented Mar 4, 2024

v0lkan Mar 4, 2024

v0lkan Mar 4, 2024

abhishek44sharma Mar 4, 2024

vmwclabot commented Mar 4, 2024

v0lkan Mar 4, 2024

		// Count how many times 'Running' appears in the command output.
		podCount := strings.Count(cmdOutput, "Running")

Enable Golang-based Integration Tests #590

Enable Golang-based Integration Tests #590

Conversation

v0lkan commented Mar 4, 2024

Enable Golang-based Integration Tests

Description

Test Policy Compliance

Code Quality

Documentation

Additional Comments

Checklist

vmwclabot commented Mar 4, 2024

vmwclabot commented Mar 4, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vmwclabot commented Mar 4, 2024

vmwclabot commented Mar 4, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vmwclabot commented Mar 4, 2024

Choose a reason for hiding this comment

vmwclabot commented Mar 4, 2024

vmwclabot commented Mar 4, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vmwclabot commented Mar 4, 2024

Choose a reason for hiding this comment