Skip to content

gitlab!925 - 1587: Use common command line handling across server, agent, and tools #1

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
wants to merge 26 commits into
base: master
Choose a base branch
from
Open

gitlab!925 - 1587: Use common command line handling across server, agent, and tools #1

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
a7e2329
[#1587] Exclude a common part of CLI parser
fivitti Jan 2, 2025
ac04f65
[#1587] Working general CLI parser
fivitti Jan 3, 2025
ffd2cf4
[#1587] Fix the wrong argument
fivitti Jan 7, 2025
8808118
[#1587] Unify agent and server parsers
fivitti Jan 7, 2025
e301a43
[#1587] Verify the envvars
fivitti Jan 7, 2025
30c4d21
[#1587] Fix linter issues
fivitti Jan 7, 2025
c8ca1c5
[#1587] Verify system environment variables
fivitti Jan 7, 2025
81b857a
[#1587] Add unit tests
fivitti Jan 7, 2025
48add73
[#1587] Extend unit test
fivitti Jan 7, 2025
06ba0b6
[#1587] Fix unit tests
fivitti Jan 7, 2025
cfb6ec4
[#1587] Simplify utility
fivitti Jan 7, 2025
7a29eb8
[#1587] Fix linter issue
fivitti Jan 8, 2025
522be1b
[#1587] Remove redundant flags
fivitti Jan 8, 2025
c6657d4
[#1587] Add unit tests
fivitti Jan 8, 2025
bf98f00
[#1587] Add a Changelog entry
fivitti Jan 8, 2025
19b7c94
[#1587] Unify the CLI handling in the Stork tool
fivitti Jan 8, 2025
66db02f
[#1587] Move package
fivitti Jan 8, 2025
425910d
[#1587] Exclude app to a separate file
fivitti Jan 8, 2025
7b201bd
[#1587] Unexport structs
fivitti Jan 8, 2025
6569020
[#1587] Unify code-gen CLI
fivitti Jan 8, 2025
27c6b7c
[#1587] Remove unnecessary dependencies
fivitti Jan 8, 2025
185123d
[#1587] Rename structs
fivitti Jan 9, 2025
f1d16f2
[#1587] Add unit tests
fivitti Jan 9, 2025
60f2fe4
[#1587] Rephrase a sentence
fivitti Jan 9, 2025
1acfd8d
[#1587] Support hooks only for agent and server
fivitti Jan 9, 2025
9285a3c
[#1587] Add unit test
fivitti Jan 9, 2025
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
Prev Previous commit
Next Next commit
[#1587] Simplify utility
  • Loading branch information
@fivitti @tomaszmrugalski
fivitti authored and tomaszmrugalski committed Jun 2, 2025
commit cfb6ec4bc1dace721e2641687de17cc3b3d7bb76
6 changes: 3 additions & 3 deletions backend/appcfg/stork/cli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,11 +289,11 @@ func (p *CLIParser) verifyEnvironmentFile(envFileSettings *environmentFileSettin
}

// Check if all environment variables are known.
for _, entry := range entries {
if _, exist := knownEnvironmentVariables[entry.GetKey()]; !exist {
for key, _ := range entries {
if _, exist := knownEnvironmentVariables[key]; !exist {
log.Warnf(
"Unknown environment variable: '%s' in the environment file: '%s'",
entry.GetKey(), envFileSettings.EnvFile,
key, envFileSettings.EnvFile,
)
}
}
Expand Down
34 changes: 6 additions & 28 deletions backend/util/envfile.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,6 @@ import (
"github.com/pkg/errors"
)

// Stores key-value of the environment variable.
type KeyValuePair [2]string

// Returns the key of the key-value pair.
func (p KeyValuePair) GetKey() string {
return p[0]
}

// Returns the value of the key-value pair.
func (p KeyValuePair) GetValue() string {
return p[1]
}

// Defines an interface that accepts the environment variables.
type EnvironmentVariableSetter interface {
Set(key, value string) error
Expand Down Expand Up @@ -49,15 +36,12 @@ func LoadEnvironmentFileToSetter(path string, setters ...EnvironmentVariableSett
return err
}

for _, pair := range data {
for key, value := range data {
for _, setter := range setters {
err = setter.Set(pair.GetKey(), pair.GetValue())
err = setter.Set(key, value)
if err != nil {
err = errors.WithMessagef(
err,
"cannot set '%s=%s' environment variable",
pair.GetKey(),
pair.GetValue(),
err, "cannot set '%s=%s' environment variable", key, value,
)
return err
}
Expand All @@ -68,7 +52,7 @@ func LoadEnvironmentFileToSetter(path string, setters ...EnvironmentVariableSett
}

// Loads all entries from the environment file.
func LoadEnvironmentFile(path string) ([]KeyValuePair, error) {
func LoadEnvironmentFile(path string) (map[string]string, error) {
file, err := os.Open(path)
if err != nil {
return nil, errors.Wrapf(err, "cannot open the '%s' environment file", path)
Expand All @@ -78,8 +62,7 @@ func LoadEnvironmentFile(path string) ([]KeyValuePair, error) {
}

// Loads all entries from a given reader.
func loadEnvironmentEntries(reader io.Reader) ([]KeyValuePair, error) {
// The order of the entries is important.
func loadEnvironmentEntries(reader io.Reader) (map[string]string, error) {
dataIndex := map[string]string{}
scanner := bufio.NewScanner(reader)

Expand All @@ -98,12 +81,7 @@ func loadEnvironmentEntries(reader io.Reader) ([]KeyValuePair, error) {
dataIndex[key] = value
}

var data []KeyValuePair
for key, value := range dataIndex {
data = append(data, [2]string{key, value})
}

return data, nil
return dataIndex, nil
}

// Parses a line of the environment file.
Expand Down
40 changes: 20 additions & 20 deletions backend/util/envfile_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ func TestLoadSingleLineEnvironmentContent(t *testing.T) {
// Assert
require.NoError(t, err)
require.Len(t, data, 1)
require.EqualValues(t, "TEST_STORK_KEY", data[0].GetKey())
require.EqualValues(t, "VALUE", data[0].GetValue())
require.Contains(t, data, "TEST_STORK_KEY")
require.EqualValues(t, "VALUE", data["TEST_STORK_KEY"])
}

// Test that the multi-line environment file content is loaded properly.
Expand All @@ -51,12 +51,12 @@ func TestLoadMultiLineEnvironmentContent(t *testing.T) {
// Assert
require.NoError(t, err)
require.Len(t, data, 3)
require.EqualValues(t, "TEST_STORK_KEY1", data[0].GetKey())
require.EqualValues(t, "VALUE1", data[0].GetValue())
require.EqualValues(t, "TEST_STORK_KEY2", data[1].GetKey())
require.EqualValues(t, "VALUE2", data[1].GetValue())
require.EqualValues(t, "TEST_STORK_KEY3", data[2].GetKey())
require.EqualValues(t, "VALUE3", data[2].GetValue())
require.Contains(t, data, "TEST_STORK_KEY1")
require.EqualValues(t, "VALUE1", data["TEST_STORK_KEY1"])
require.Contains(t, data, "TEST_STORK_KEY2")
require.EqualValues(t, "VALUE2", data["TEST_STORK_KEY2"])
require.Contains(t, data, "TEST_STORK_KEY3")
require.EqualValues(t, "VALUE3", data["TEST_STORK_KEY3"])
}

// Test that the duplicates in the content are overwritten properly.
Expand All @@ -72,8 +72,8 @@ func TestLoadEnvironmentContentWithDuplicates(t *testing.T) {
// Assert
require.NoError(t, err)
require.Len(t, data, 1)
require.EqualValues(t, "TEST_STORK_KEY1", data[0].GetKey())
require.EqualValues(t, "VALUE3", data[0].GetValue())
require.Contains(t, data, "TEST_STORK_KEY1")
require.EqualValues(t, "VALUE3", data["TEST_STORK_KEY1"])
}

// Test that the empty value in the environment file content is loaded properly.
Expand All @@ -87,8 +87,8 @@ func TestLoadEnvironmentContentWithEmptyValue(t *testing.T) {
// Assert
require.Len(t, data, 1)
require.NoError(t, err)
require.EqualValues(t, "TEST_STORK_KEY", data[0].GetKey())
require.EqualValues(t, "", data[0].GetValue())
require.Contains(t, data, "TEST_STORK_KEY")
require.EqualValues(t, "", data["TEST_STORK_KEY"])
}

// Test that the missing value separator in the environment file content
Expand Down Expand Up @@ -146,8 +146,8 @@ func TestLoadEnvironmentContentWithComments(t *testing.T) {
// Assert
require.NoError(t, err)
require.Len(t, data, 1)
require.EqualValues(t, "TEST_STORK_KEY2", data[0].GetKey())
require.EqualValues(t, "VALUE2", data[0].GetValue())
require.Contains(t, data, "TEST_STORK_KEY2")
require.EqualValues(t, "VALUE2", data["TEST_STORK_KEY2"])
}

// Test that the empty lines are skipped.
Expand All @@ -162,10 +162,10 @@ func TestLoadEnvironmentContentWithEmptyLine(t *testing.T) {

// Assert
require.NoError(t, err)
require.EqualValues(t, "TEST_STORK_KEY1", data[0].GetKey())
require.EqualValues(t, "VALUE1", data[0].GetValue())
require.EqualValues(t, "TEST_STORK_KEY2", data[1].GetKey())
require.EqualValues(t, "VALUE2", data[1].GetValue())
require.Contains(t, data, "TEST_STORK_KEY1")
require.EqualValues(t, "VALUE1", data["TEST_STORK_KEY1"])
require.Contains(t, data, "TEST_STORK_KEY2")
require.EqualValues(t, "VALUE2", data["TEST_STORK_KEY2"])
require.Len(t, data, 2)
}

Expand All @@ -182,8 +182,8 @@ func TestLoadEnvironmentContentWithTrailingCharacters(t *testing.T) {
// Assert
require.NoError(t, err)
require.Len(t, data, 1)
require.EqualValues(t, "TEST_STORK_KEY2", data[0].GetKey())
require.EqualValues(t, "VALUE2", data[0].GetValue())
require.Contains(t, data, "TEST_STORK_KEY2")
require.EqualValues(t, "VALUE2", data["TEST_STORK_KEY2"])
}

type setterMock struct {
Expand Down