mirror of
https://github.com/kubevela/kubevela.git
synced 2026-02-14 18:10:21 +00:00
* feat(env): Add comprehensive unit tests for environment management This commit introduces a comprehensive suite of unit tests for the environment management functions in `pkg/utils/env`. Key changes include: - Refactoring the test setup to use `TestMain` for better test environment control. - Adding new test cases for `CreateEnv`, `GetEnvByName`, `ListEnvs`, `SetCurrentEnv`, `SetEnvLabels`, and `DeleteEnv`. These tests improve the overall test coverage and ensure the correctness and reliability of environment-related operations. Signed-off-by: Ashvin Bambhaniya <ashvin.bambhaniya@improwised.com> * feat(errors): Add unit tests for error handling utilities This commit introduces new unit tests for the error handling utilities located in `pkg/utils/errors/`. Specifically, new test files have been added for: - `crd_test.go`: Tests for CRD-related error checks. - `list_test.go`: Tests for error list aggregation. - `reason_test.go`: Tests for specific error reasons like label conflicts and CUE path not found. - `resourcetracker_test.go`: Tests for resource tracker errors. These additions improve the test coverage and ensure the robustness of KubeVela's error handling mechanisms. Signed-off-by: Ashvin Bambhaniya <ashvin.bambhaniya@improwised.com> * refactor(schema): Refactor ui_schema_test.go to use testify/assert and add new test cases This commit refactors `pkg/utils/schema/ui_schema_test.go` to improve its readability and maintainability. Key changes include: - Migrating from Ginkgo/Gomega to testify/assert for assertions. - Restructuring `TestGetDefaultUIType` into a table-driven test. - Adding new comprehensive test cases for `Condition_Validate` function. These changes enhance the test suite for UI schema utilities, making it more robust and easier to extend. Signed-off-by: Ashvin Bambhaniya <ashvin.bambhaniya@improwised.com> * refactor(system): Refactor system_test.go and add comprehensive unit tests This commit refactors `pkg/utils/system/system_test.go` to improve its structure, readability, and test coverage. Key changes include: - Converting existing tests to a table-driven format using `testify/assert`. - Adding new comprehensive test cases for: - `CreateIfNotExist` - `GetVelaHomeDir` - `GetDirectoryFunctions` (e.g., `GetCapCenterDir`, `GetCapabilityDir`) - `InitFunctions` (e.g., `InitCapabilityDir`, `InitCapCenterDir`, `InitDirs`) - `BindEnvironmentVariables` These changes enhance the test suite for system utilities, ensuring their correctness and robustness. Signed-off-by: Ashvin Bambhaniya <ashvin.bambhaniya@improwised.com> * feat(types): Add unit tests for QL types This commit introduces new unit tests for the types defined in `pkg/utils/types`, specifically focusing on types related to KubeVela Query Language (QL). New test cases cover: - `ServiceEndpoint.String()`: Verifies the string representation of service endpoints, including various protocols, ports, and paths. - `AppliedResource.GroupVersionKind()`: Ensures correct extraction of GroupVersionKind from applied resources. - `ResourceTreeNode.GroupVersionKind()`: Verifies correct extraction of GroupVersionKind from resource tree nodes. These tests improve the coverage and reliability of core data structures used in KubeVela. Signed-off-by: Ashvin Bambhaniya <ashvin.bambhaniya@improwised.com> * feat(util): Add and refactor unit tests for utility functions This commit introduces new unit tests and refactors existing ones within the `pkg/utils/util` package. Key changes include: - **`pkg/utils/util/cmd_test.go`**: Adds comprehensive tests for `IOStreams` and its print functions, as well as `NewDefaultIOStreams` and `NewTestIOStreams`. - **`pkg/utils/util/factory_test.go`**: Refactors the `GenerateLeaderElectionID` test to a table-driven format and adds new tests for `computeDiscoverCacheDir` and `RestConfigGetter` methods, ensuring the correctness of Kubernetes client configuration and discovery. These additions and refactorings enhance the test coverage and reliability of core utility functions. Signed-off-by: Ashvin Bambhaniya <ashvin.bambhaniya@improwised.com> * feat(utils): Add and refactor unit tests for json, jwt, parse, and strings utilities This commit introduces new unit tests and refactors existing ones across several utility packages within `pkg/utils/`. Key changes include: - **`pkg/utils/json`**: Adds tests for `StrictUnmarshal` to ensure proper JSON unmarshaling. - **`pkg/utils/jwt`**: Adds tests for JWT token subject extraction and certificate subject retrieval. - **`pkg/utils/parse`**: Expands test coverage for URL parsing functions (`Parse`, `ParseGitlab`). - **`pkg/utils/strings`**: Refactors existing tests to a table-driven format and adds tests for box drawing string generation. These additions and refactorings significantly improve the test coverage and reliability of KubeVela's utility functions. Signed-off-by: Ashvin Bambhaniya <ashvin.bambhaniya@improwised.com> * fix(tests): Address test and error handling issues This commit addresses several issues identified in unit tests and error handling utilities, improving test reliability and code safety. Key fixes and improvements include: - **`pkg/utils/errors`**: - Added nil check to `IsCuePathNotFound` to prevent panics. - Corrected `fmt.Errorf` usage to `errors.New` in `reason_test.go` (SA1006 fix). - Used `assert.EqualError` for clearer error message comparisons in `resourcetracker_test.go`. - **`pkg/utils/jwt_test.go`**: Marked `generateTestCert` as a test helper using `t.Helper()` for better error reporting. - **`pkg/utils/system_test.go`**: - Removed unused `verifyCleanup` field. - Modified `TestGetVelaHomeDir` to use a temporary home directory, preventing destructive operations on the user's system. - **`pkg/utils/util/cmd_test.go`**: Swapped `assert.Equal` arguments to follow `expected, actual` convention. These changes enhance the robustness and correctness of the test suite and related utility functions. Signed-off-by: Ashvin Bambhaniya <ashvin.bambhaniya@improwised.com> * chore(tests): Apply gofmt and import ordering to test files This commit applies standard Go formatting (`gofmt`) and corrects import ordering in several test files. Affected files: - `pkg/utils/schema/ui_schema_test.go`: Added missing newline at EOF. - `pkg/utils/system/system_test.go`: Corrected import ordering. - `pkg/utils/util/factory_test.go`: Corrected import ordering. These changes ensure consistency with project coding standards. Signed-off-by: Ashvin Bambhaniya <ashvin.bambhaniya@improwised.com> --------- Signed-off-by: Ashvin Bambhaniya <ashvin.bambhaniya@improwised.com>
193 lines
5.2 KiB
Go
193 lines
5.2 KiB
Go
/*
|
|
Copyright 2021 The KubeVela Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package utils
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestByteCountIEC(t *testing.T) {
|
|
testCases := map[string]struct {
|
|
Input int64
|
|
Output string
|
|
}{
|
|
"1 B": {
|
|
Input: int64(1),
|
|
Output: "1 B",
|
|
},
|
|
"1.1 KiB": {
|
|
Input: int64(1124),
|
|
Output: "1.1 KiB",
|
|
},
|
|
"1.2 MiB": {
|
|
Input: int64(1258291),
|
|
Output: "1.2 MiB",
|
|
},
|
|
"3.3 GiB": {
|
|
Input: int64(3543348020),
|
|
Output: "3.3 GiB",
|
|
},
|
|
}
|
|
r := require.New(t)
|
|
for name, tt := range testCases {
|
|
t.Run(name, func(t *testing.T) {
|
|
r.Equal(tt.Output, ByteCountIEC(tt.Input))
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestParse(t *testing.T) {
|
|
testCases := []struct {
|
|
name string
|
|
addr string
|
|
wantType string
|
|
wantContent *Content
|
|
wantErr bool
|
|
}{
|
|
{
|
|
name: "github url with branch",
|
|
addr: "https://github.com/kubevela/catalog/tree/master/addons/fluxcd",
|
|
wantType: TypeGithub,
|
|
wantContent: &Content{GithubContent: GithubContent{Owner: "kubevela", Repo: "catalog", Path: "addons/fluxcd", Ref: "master"}},
|
|
},
|
|
{
|
|
name: "github url without branch",
|
|
addr: "https://github.com/kubevela/catalog/addons/fluxcd",
|
|
wantType: TypeGithub,
|
|
wantContent: &Content{GithubContent: GithubContent{Owner: "kubevela", Repo: "catalog", Path: "addons/fluxcd", Ref: ""}},
|
|
},
|
|
{
|
|
name: "github api url with single segment path",
|
|
addr: "https://api.github.com/repos/kubevela/catalog/contents/my-addon?ref=master",
|
|
wantType: TypeGithub,
|
|
wantContent: &Content{GithubContent: GithubContent{Owner: "kubevela", Repo: "catalog", Path: "my-addon", Ref: "master"}},
|
|
},
|
|
{
|
|
name: "gitee url with branch",
|
|
addr: "https://gitee.com/kubevela/catalog/tree/master/addons/fluxcd",
|
|
wantType: TypeGitee,
|
|
wantContent: &Content{GiteeContent: GiteeContent{Owner: "kubevela", Repo: "catalog", Path: "addons/fluxcd", Ref: "master"}},
|
|
},
|
|
{
|
|
name: "gitee url without branch",
|
|
addr: "https://gitee.com/kubevela/catalog/addons/fluxcd",
|
|
wantType: TypeGitee,
|
|
wantContent: &Content{GiteeContent: GiteeContent{Owner: "kubevela", Repo: "catalog", Path: "addons/fluxcd", Ref: ""}},
|
|
},
|
|
{
|
|
name: "oss url",
|
|
addr: "oss://kubevela-contrib/registry",
|
|
wantType: TypeOss,
|
|
wantContent: &Content{OssContent: OssContent{EndPoint: "kubevela-contrib", Bucket: "/registry"}},
|
|
},
|
|
{
|
|
name: "local url",
|
|
addr: "file:///Users/somebody/addons",
|
|
wantType: TypeLocal,
|
|
wantContent: &Content{LocalContent: LocalContent{AbsDir: "/Users/somebody/addons"}},
|
|
},
|
|
{
|
|
name: "invalid github url",
|
|
addr: "https://github.com/kubevela",
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "unsupported git url",
|
|
addr: "https://bitbucket.org/foo/bar",
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "malformed url",
|
|
addr: "://abc",
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "unknown type",
|
|
addr: "myscheme://foo/bar",
|
|
wantType: TypeUnknown,
|
|
},
|
|
}
|
|
|
|
for _, tc := range testCases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
gotType, gotContent, err := Parse(tc.addr)
|
|
if tc.wantErr {
|
|
require.Error(t, err)
|
|
return
|
|
}
|
|
require.NoError(t, err)
|
|
require.Equal(t, tc.wantType, gotType)
|
|
require.Equal(t, tc.wantContent, gotContent)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestParseGitlab(t *testing.T) {
|
|
testCases := []struct {
|
|
name string
|
|
addr string
|
|
repo string
|
|
wantType string
|
|
wantContent *Content
|
|
wantErr bool
|
|
}{
|
|
{
|
|
name: "gitlab url without branch",
|
|
addr: "https://gitlab.com/kubevela/catalog",
|
|
repo: "catalog",
|
|
wantType: TypeGitlab,
|
|
wantContent: &Content{GitlabContent: GitlabContent{Host: "https://gitlab.com", Owner: "kubevela", Repo: "catalog", Ref: ""}},
|
|
},
|
|
{
|
|
name: "gitlab url with branch",
|
|
addr: "https://gitlab.com/kubevela/catalog/tree/master",
|
|
repo: "catalog",
|
|
wantType: TypeGitlab,
|
|
wantContent: &Content{GitlabContent: GitlabContent{Host: "https://gitlab.com", Owner: "kubevela", Repo: "catalog", Ref: "master"}},
|
|
},
|
|
{
|
|
name: "invalid gitlab url repo not match",
|
|
addr: "https://gitlab.com/kubevela/catalog",
|
|
repo: "wrong-repo",
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "malformed gitlab url",
|
|
addr: "://abc",
|
|
repo: "repo",
|
|
wantErr: true,
|
|
},
|
|
}
|
|
|
|
for _, tc := range testCases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
gotType, gotContent, err := ParseGitlab(tc.addr, tc.repo)
|
|
if tc.wantErr {
|
|
require.Error(t, err)
|
|
return
|
|
}
|
|
require.NoError(t, err)
|
|
require.Equal(t, tc.wantType, gotType)
|
|
require.Equal(t, tc.wantContent, gotContent)
|
|
})
|
|
}
|
|
}
|