chore: read environment addons from the workspace

[Lou1415926]

This PR implements methods to read environment addons from the workspace in copilot/environments/addons folder.

Related: #4219

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the Apache 2.0 License.

[codecov-commenter]

Codecov Report

Merging #4147 (534fd24) into mainline (7a86fde) will increase coverage by 0.02%.
The diff coverage is 82.69%.

@@             Coverage Diff              @@
##           mainline    #4147      +/-   ##
============================================
+ Coverage     69.21%   69.24%   +0.02%     
============================================
  Files           250      250              
  Lines         35885    35927      +42     
  Branches        264      264              
============================================
+ Hits          24838    24876      +38     
- Misses         9854     9856       +2     
- Partials       1193     1195       +2     

Impacted Files	Coverage Δ
internal/pkg/addon/addons.go	83.67% <70.00%> (-2.70%)	⬇️
internal/pkg/workspace/workspace.go	71.45% <90.62%> (+2.17%)	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[efekarakus]

Thanks for the great test cases

Let me know what you think of the suggestion below!

[efekarakus]

Instead of ReadWorkloadAddonsDir vs ReadEnvAddonsDir, what do you think of the following API?

package workspace

// ListAddonsFiles returns a list of file paths to all the addons templates defined under the dir.
func (ws *Workspace) ListAddonsFiles(dirPath string) ([]string, error)

// ReadAddonsFile reads the addons template file under fpath.
func (ws *Workspace) ReadAddonsFile(fpath string) ([]byte, error)

// EnvAddonsPath returns the addons/ directory file path for environments.
func (ws *Workspace) EnvAddonsPath() string

// WorkloadAddonsPath returns the addons/ directory file path for a given workload.
func (ws *Workspace) WorkloadAddonsPath(name string) string

The idea is to have a generic ListAddonsFiles that can be given as input the EnvAddonsPath or WorkloadAddonsPath.

[Lou1415926]

Addressed!

I actually had:

WorkloadAddonsPath(name string) (string, error)
WorkloadAddonFilePath(wkldName, fName string) (string, error)
EnvAddonsPath() string
EnvAddonFilePath() string
ListFiles(dirPath string) ([]string, error)
ReadFile(fPath string) ([]byte, error)

So that we are still letting the workspace package to determine how an addon file is arranged under an addons/ directory. lmk how you like it!

[github-actions]

🍕 Here are the new binary sizes!

Name	New size (kiB)	v1.23.0 size (kiB)	Delta (%)
macOS (amd)	47812	47548	+0.56
macOS (arm)	47812	48200	❤️ -0.80
linux (amd)	42044	41820	+0.54
linux (arm)	42044	41220	🥺 +2.00
windows (amd)	38876	38664	+0.55

[dannyrandall]

looks great, just a nit!

[dannyrandall]

should probably update this error since it could be reading a manifest file or an addon file now

[efekarakus]

I wonder if we could have gotten-rid of so many of our errors if we had a different approach to New in our package. For example:

package workspace

// Workspace is a created copilot/ directory in a git repository.
type Workspace struct{...}

// Use returns an existing workspace and replaces the old "New" function. 
// It searches a copilot/ directory from the current wd, up to 5 levels above.
func Use() (*Workspace, error) { ... }

// Create is no longer a method and instead is a function that creates a new *Workspace in the current working directory for appName.
func Create(appName string) (*Workspace, error)

With the above API, I think we can completely ditch the copilotDirPath error because *Workspace will have the value stored in a field.

Let me know what you think of the above, if it sounds good we can do it as a follow-up to this PR?

[Lou1415926]

Makes sense to me!

We can use Use() to do what've been done by copilotDirPath so that the rest of the operations can proceed with the assumption that we are in a worksapce.