Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Documentation update. #1003

Merged
merged 1 commit into from
Jun 17, 2024
Merged

Documentation update. #1003

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 0 additions & 63 deletions core/env/safe_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,69 +472,6 @@ func TestRootKeyInputMode(t *testing.T) {
}
}

//func TestManualRootKeyUpdatesK8sSecrets(t *testing.T) {
// tests := []struct {
// name string
// setup func() error
// cleanup func() error
// want bool
// }{
// {
// name: "default_safe_manual_root_key_updates_k8s_secret",
// want: false,
// },
// {
// name: "safe_manual_root_key_updates_k8s_secret_from_env_true",
// setup: func() error {
// return os.Setenv("VSECM_MANUAL_ROOT_KEY_UPDATES_K8S_SECRET", "true")
// },
// cleanup: func() error {
// return os.Unsetenv("VSECM_MANUAL_ROOT_KEY_UPDATES_K8S_SECRET")
// },
// want: true,
// },
// {
// name: "safe_manual_root_key_updates_k8s_secret_from_env_false",
// setup: func() error {
// return os.Setenv("VSECM_MANUAL_ROOT_KEY_UPDATES_K8S_SECRET", "false")
// },
// cleanup: func() error {
// return os.Unsetenv("VSECM_MANUAL_ROOT_KEY_UPDATES_K8S_SECRET")
// },
// want: false,
// },
// {
// name: "invalid_safe_manual_root_key_updates_k8s_secret_from_env",
// setup: func() error {
// return os.Setenv("VSECM_MANUAL_ROOT_KEY_UPDATES_K8S_SECRET", "test")
// },
// cleanup: func() error {
// return os.Unsetenv("VSECM_MANUAL_ROOT_KEY_UPDATES_K8S_SECRET")
// },
// want: false,
// },
// }
// for _, tt := range tests {
// t.Run(tt.name, func(t *testing.T) {
// if tt.setup != nil {
// if err := tt.setup(); err != nil {
// t.Errorf("ManualRootKeyUpdatesK8sSecret() = failed to setup, with error: %+v", err)
// }
// }
// defer func() {
// if tt.cleanup != nil {
// if err := tt.cleanup(); err != nil {
// t.Errorf("ManualRootKeyUpdatesK8sSecret() = failed to cleanup, with error: %+v", err)
// }
// }
// }()
// if got := ManualRootKeyUpdatesK8sSecret(); got != tt.want {
// t.Errorf("ManualRootKeyUpdatesK8sSecret() = %v, want %v", got, tt.want)
// }
// })
// }
//}

func TestSafeDataPath(t *testing.T) {
tests := []struct {
name string
Expand Down
26 changes: 2 additions & 24 deletions core/log/std/envinfo_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,30 +197,8 @@ package std
// t.Errorf("Unexpected output:\nExpected: \n%s\nActual: \n%s", expectedOutput, capturedOutput.String())
// }
//}
//
//func TestPrintAdditionalInformation(t *testing.T) {
// // Prepare the input data
// info := make(map[string]string)
//
// // Call the function
// printAdditionalInformation(info)
//
// // Expected values
// expectedEnvVariables := strings.Join(getAllEnvironmentVariables(), ", ")
// expectedGoVersion := runtime.Version()
//
// // Compare actual vs expected values
// if info["ENVIRONMENT_VARIABLES"] != expectedEnvVariables {
// t.Errorf("Unexpected value for ENVIRONMENT_VARIABLES:\nExpected: %s\nActual: %s",
// expectedEnvVariables, info["ENVIRONMENT_VARIABLES"])
// }
//
// if info["GO_VERSION"] != expectedGoVersion {
// t.Errorf("Unexpected value for GO_VERSION:\nExpected: %s\nActual: %s",
// expectedGoVersion, info["GO_VERSION"])
// }
//}
//


//func mockLogger(t *testing.T) (*bufio.Scanner, *os.File, *os.File) {
// reader, writer, err := os.Pipe()
// if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion ...ntent/documentation/architecture/adrs/20240510-adr-0006-be-secure-by-default.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ weight = 6
## Context and Problem Statement

**VMware Secrets Manager** stores your sensitive data in memory. None of your
secrets are stored as plain text on disk. Any secret that**VMware Secrets
secrets are stored as plain text on disk. Any secret that **VMware Secrets
Manager** saves to any other medium is encrypted.

Yes, that brings up resource limitations, since the amount of secrets you can
Expand Down
12 changes: 12 additions & 0 deletions docs/content/documentation/operations/release-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,18 @@ For example `make k8s-manifests-update VERSION=0.22.4`

### 10. Release Helm Charts

> **Pull Recent `gh-pages` Changes**
>
> Before you proceed, make sure that you have your `gh-pages` local branc
> is up to date:
>
> ```bash
> cd $WORKSPACE/secrets-manager
> git checkout gh-pages
> git pull
> git checkout main
> ```

We offer the [./hack/release-helm-chart.sh][release_script] script for your use.
To execute the script, provide the version of the helm-charts that you want
to release as an argument.
Expand Down
2 changes: 1 addition & 1 deletion docs/sass/_search.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
margin-top: 1em;
display: inline-block;
position: relative;
width: 300px;
width: 200px;
z-index: 999;

input {
Expand Down
3 changes: 3 additions & 0 deletions hack/test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@
# Enable strict error checking.
set -euo pipefail

# Update vendor dependencies:
go mod vendor

echo "Running Go unit tests..."
if ! go test ./... -cover; then
echo "Go unit tests failed, exiting."
Expand Down