Skip to content

feat: Show permissions boundary policy name in app show #4071

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

Merged
mergify merged 5 commits into from
Oct 13, 2022
Merged

feat: Show permissions boundary policy name in app show #4071

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
64701bc
adding permission boundaries
KollaAdithya Oct 7, 2022
2aad03b
changes to json field
KollaAdithya Oct 7, 2022
b2e29fe
addressing feedback
KollaAdithya Oct 10, 2022
fc27703
Merge branch 'mainline' into permissionboundary
mergify[bot] Oct 10, 2022
60cf61f
Merge branch 'mainline' into permissionboundary
mergify[bot] Oct 13, 2022
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
17 changes: 9 additions & 8 deletions internal/pkg/cli/app_show.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,14 +217,15 @@ func (o *showAppOpts) description() (*describe.App, error) {
return nil, fmt.Errorf("get version for application %s: %w", o.name, err)
}
return &describe.App{
Name: app.Name,
Version: version,
URI: app.Domain,
Envs: trimmedEnvs,
Services: trimmedSvcs,
Jobs: trimmedJobs,
Pipelines: pipelineInfo,
WkldDeployedtoEnvs: wkldDeployedtoEnvs,
Name: app.Name,
Version: version,
URI: app.Domain,
PermissionsBoundary: app.PermissionsBoundary,
Envs: trimmedEnvs,
Services: trimmedSvcs,
Jobs: trimmedJobs,
Pipelines: pipelineInfo,
WkldDeployedtoEnvs: wkldDeployedtoEnvs,
}, nil
}

Expand Down
152 changes: 117 additions & 35 deletions internal/pkg/cli/app_show_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,8 +188,9 @@ func TestShowAppOpts_Execute(t *testing.T) {

setupMocks: func(m showAppMocks) {
m.storeSvc.EXPECT().GetApplication("my-app").Return(&config.Application{
Name: "my-app",
Domain: "example.com",
Name: "my-app",
Domain: "example.com",
PermissionsBoundary: "examplePermissionsBoundaryPolicy",
}, nil)
m.storeSvc.EXPECT().ListServices("my-app").Return([]*config.Workload{
{
Expand Down Expand Up @@ -231,13 +232,14 @@ func TestShowAppOpts_Execute(t *testing.T) {
m.versionGetter.EXPECT().Version().Return("v0.0.0", nil)
},

wantedContent: "{\"name\":\"my-app\",\"version\":\"v0.0.0\",\"uri\":\"example.com\",\"environments\":[{\"app\":\"\",\"name\":\"test\",\"region\":\"us-west-2\",\"accountID\":\"123456789\",\"registryURL\":\"\",\"executionRoleARN\":\"\",\"managerRoleARN\":\"\"},{\"app\":\"\",\"name\":\"prod\",\"region\":\"us-west-1\",\"accountID\":\"123456789\",\"registryURL\":\"\",\"executionRoleARN\":\"\",\"managerRoleARN\":\"\"}],\"services\":[{\"app\":\"\",\"name\":\"my-svc\",\"type\":\"lb-web-svc\"}],\"jobs\":[{\"app\":\"\",\"name\":\"my-job\",\"type\":\"Scheduled Job\"}],\"pipelines\":[{\"pipelineName\":\"my-pipeline-repo\",\"region\":\"\",\"accountId\":\"\",\"stages\":null,\"createdAt\":\"0001-01-01T00:00:00Z\",\"updatedAt\":\"0001-01-01T00:00:00Z\"},{\"pipelineName\":\"bad-goose\",\"region\":\"\",\"accountId\":\"\",\"stages\":null,\"createdAt\":\"0001-01-01T00:00:00Z\",\"updatedAt\":\"0001-01-01T00:00:00Z\"}]}\n",
wantedContent: "{\"name\":\"my-app\",\"version\":\"v0.0.0\",\"uri\":\"example.com\",\"permissionsBoundary\":\"examplePermissionsBoundaryPolicy\",\"environments\":[{\"app\":\"\",\"name\":\"test\",\"region\":\"us-west-2\",\"accountID\":\"123456789\",\"registryURL\":\"\",\"executionRoleARN\":\"\",\"managerRoleARN\":\"\"},{\"app\":\"\",\"name\":\"prod\",\"region\":\"us-west-1\",\"accountID\":\"123456789\",\"registryURL\":\"\",\"executionRoleARN\":\"\",\"managerRoleARN\":\"\"}],\"services\":[{\"app\":\"\",\"name\":\"my-svc\",\"type\":\"lb-web-svc\"}],\"jobs\":[{\"app\":\"\",\"name\":\"my-job\",\"type\":\"Scheduled Job\"}],\"pipelines\":[{\"pipelineName\":\"my-pipeline-repo\",\"region\":\"\",\"accountId\":\"\",\"stages\":null,\"createdAt\":\"0001-01-01T00:00:00Z\",\"updatedAt\":\"0001-01-01T00:00:00Z\"},{\"pipelineName\":\"bad-goose\",\"region\":\"\",\"accountId\":\"\",\"stages\":null,\"createdAt\":\"0001-01-01T00:00:00Z\",\"updatedAt\":\"0001-01-01T00:00:00Z\"}]}\n",
},
"correctly shows human output": {
setupMocks: func(m showAppMocks) {
m.storeSvc.EXPECT().GetApplication("my-app").Return(&config.Application{
Name: "my-app",
Domain: "example.com",
Name: "my-app",
Domain: "example.com",
PermissionsBoundary: "examplePermissionsBoundaryPolicy",
}, nil)
m.storeSvc.EXPECT().ListServices("my-app").Return([]*config.Workload{
{
Expand Down Expand Up @@ -281,9 +283,10 @@ func TestShowAppOpts_Execute(t *testing.T) {

wantedContent: `About

Name my-app
Version v0.0.0 (latest available: v1.1.0)
URI example.com
Name my-app
Version v0.0.0 (latest available: v1.1.0)
URI example.com
Permissions Boundary examplePermissionsBoundaryPolicy

Environments

Expand All @@ -310,8 +313,9 @@ Pipelines
"correctly shows human output with latest version": {
setupMocks: func(m showAppMocks) {
m.storeSvc.EXPECT().GetApplication("my-app").Return(&config.Application{
Name: "my-app",
Domain: "example.com",
Name: "my-app",
Domain: "example.com",
PermissionsBoundary: "examplePermissionsBoundaryPolicy",
}, nil)
m.storeSvc.EXPECT().ListServices("my-app").Return([]*config.Workload{
{
Expand Down Expand Up @@ -347,9 +351,77 @@ Pipelines

wantedContent: `About

Name my-app
Version v1.1.0
URI example.com
Name my-app
Version v1.1.0
URI example.com
Permissions Boundary examplePermissionsBoundaryPolicy
Comment thread
KollaAdithya marked this conversation as resolved.

Environments

Name AccountID Region
---- --------- ------
test 123456789 us-west-2
prod 123456789 us-west-1

Workloads

Name Type Environments
---- ---- ------------
my-svc lb-web-svc prod, test
my-job Scheduled Job prod, test

Pipelines

Name
----
`,
},
"correctly shows human output when URI and Permissions Boundary are empty": {
setupMocks: func(m showAppMocks) {
m.storeSvc.EXPECT().GetApplication("my-app").Return(&config.Application{
Name: "my-app",
Domain: "",
PermissionsBoundary: "",
}, nil)
m.storeSvc.EXPECT().ListServices("my-app").Return([]*config.Workload{
{
Name: "my-svc",
Type: "lb-web-svc",
},
}, nil)
m.storeSvc.EXPECT().ListJobs("my-app").Return([]*config.Workload{
{
Name: "my-job",
Type: "Scheduled Job",
},
}, nil)
m.storeSvc.EXPECT().ListEnvironments("my-app").Return([]*config.Environment{
{
Name: "test",
Region: "us-west-2",
AccountID: "123456789",
},
{
Name: "prod",
AccountID: "123456789",
Region: "us-west-1",
},
}, nil)
m.deployStore.EXPECT().ListDeployedJobs("my-app", "test").Return([]string{"my-job"}, nil)
m.deployStore.EXPECT().ListDeployedJobs("my-app", "prod").Return([]string{"my-job"}, nil)
m.deployStore.EXPECT().ListDeployedServices("my-app", "test").Return([]string{"my-svc"}, nil)
m.deployStore.EXPECT().ListDeployedServices("my-app", "prod").Return([]string{"my-svc"}, nil)
m.pipelineLister.EXPECT().ListDeployedPipelines(mockAppName).Return([]deploy.Pipeline{}, nil)
m.versionGetter.EXPECT().Version().Return(deploy.LatestAppTemplateVersion, nil)

},

wantedContent: `About

Name my-app
Version v1.1.0
URI N/A
Permissions Boundary N/A

Environments

Expand All @@ -374,8 +446,9 @@ Pipelines
"when service/job is not deployed": {
setupMocks: func(m showAppMocks) {
m.storeSvc.EXPECT().GetApplication("my-app").Return(&config.Application{
Name: "my-app",
Domain: "example.com",
Name: "my-app",
Domain: "example.com",
PermissionsBoundary: "examplePermissionsBoundaryPolicy",
}, nil)
m.storeSvc.EXPECT().ListServices("my-app").Return([]*config.Workload{
{
Expand Down Expand Up @@ -415,9 +488,10 @@ Pipelines

wantedContent: `About

Name my-app
Version v1.1.0
URI example.com
Name my-app
Version v1.1.0
URI example.com
Permissions Boundary examplePermissionsBoundaryPolicy

Environments

Expand All @@ -442,8 +516,9 @@ Pipelines
}, "when multiple services/jobs are deployed": {
setupMocks: func(m showAppMocks) {
m.storeSvc.EXPECT().GetApplication("my-app").Return(&config.Application{
Name: "my-app",
Domain: "example.com",
Name: "my-app",
Domain: "example.com",
PermissionsBoundary: "examplePermissionsBoundaryPolicy",
}, nil)
m.storeSvc.EXPECT().ListServices("my-app").Return([]*config.Workload{
{
Expand Down Expand Up @@ -504,9 +579,10 @@ Pipelines

wantedContent: `About

Name my-app
Version v1.1.0
URI example.com
Name my-app
Version v1.1.0
URI example.com
Permissions Boundary examplePermissionsBoundaryPolicy

Environments

Expand Down Expand Up @@ -544,8 +620,9 @@ Pipelines
"returns error if fail to list environment": {
setupMocks: func(m showAppMocks) {
m.storeSvc.EXPECT().GetApplication("my-app").Return(&config.Application{
Name: "my-app",
Domain: "example.com",
Name: "my-app",
Domain: "example.com",
PermissionsBoundary: "examplePermissionsBoundaryPolicy",
}, nil)
m.storeSvc.EXPECT().ListEnvironments("my-app").Return(nil, testError)
},
Expand All @@ -557,8 +634,9 @@ Pipelines

setupMocks: func(m showAppMocks) {
m.storeSvc.EXPECT().GetApplication("my-app").Return(&config.Application{
Name: "my-app",
Domain: "example.com",
Name: "my-app",
Domain: "example.com",
PermissionsBoundary: "examplePermissionsBoundaryPolicy",
}, nil)
m.storeSvc.EXPECT().ListEnvironments("my-app").Return([]*config.Environment{
{
Expand All @@ -582,8 +660,9 @@ Pipelines

setupMocks: func(m showAppMocks) {
m.storeSvc.EXPECT().GetApplication("my-app").Return(&config.Application{
Name: "my-app",
Domain: "example.com",
Name: "my-app",
Domain: "example.com",
PermissionsBoundary: "examplePermissionsBoundaryPolicy",
}, nil)
m.storeSvc.EXPECT().ListEnvironments("my-app").Return([]*config.Environment{
{
Expand Down Expand Up @@ -613,8 +692,9 @@ Pipelines

setupMocks: func(m showAppMocks) {
m.storeSvc.EXPECT().GetApplication("my-app").Return(&config.Application{
Name: "my-app",
Domain: "example.com",
Name: "my-app",
Domain: "example.com",
PermissionsBoundary: "examplePermissionsBoundaryPolicy",
}, nil)
m.storeSvc.EXPECT().ListEnvironments("my-app").Return([]*config.Environment{
{
Expand Down Expand Up @@ -653,8 +733,9 @@ Pipelines

setupMocks: func(m showAppMocks) {
m.storeSvc.EXPECT().GetApplication("my-app").Return(&config.Application{
Name: "my-app",
Domain: "example.com",
Name: "my-app",
Domain: "example.com",
PermissionsBoundary: "examplePermissionsBoundaryPolicy",
}, nil)
m.storeSvc.EXPECT().ListEnvironments("my-app").Return([]*config.Environment{
{
Expand Down Expand Up @@ -695,8 +776,9 @@ Pipelines

setupMocks: func(m showAppMocks) {
m.storeSvc.EXPECT().GetApplication("my-app").Return(&config.Application{
Name: "my-app",
Domain: "example.com",
Name: "my-app",
Domain: "example.com",
PermissionsBoundary: "examplePermissionsBoundaryPolicy",
}, nil)
m.storeSvc.EXPECT().ListEnvironments("my-app").Return([]*config.Environment{
{
Expand Down
24 changes: 16 additions & 8 deletions internal/pkg/describe/app.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,15 @@ import (

// App contains serialized parameters for an application.
type App struct {
Name string `json:"name"`
Version string `json:"version"`
URI string `json:"uri"`
Envs []*config.Environment `json:"environments"`
Services []*config.Workload `json:"services"`
Jobs []*config.Workload `json:"jobs"`
Pipelines []*codepipeline.Pipeline `json:"pipelines"`
WkldDeployedtoEnvs map[string][]string `json:"-"`
Name string `json:"name"`
Version string `json:"version"`
URI string `json:"uri"`
PermissionsBoundary string `json:"permissionsBoundary"`
Envs []*config.Environment `json:"environments"`
Services []*config.Workload `json:"services"`
Jobs []*config.Workload `json:"jobs"`
Pipelines []*codepipeline.Pipeline `json:"pipelines"`
WkldDeployedtoEnvs map[string][]string `json:"-"`
}

// JSONString returns the stringified App struct with json format.
Expand All @@ -53,8 +54,15 @@ func (a *App) HumanString() string {
if deploy.LatestAppTemplateVersion != a.Version {
availableVersion = color.Yellow.Sprintf("(latest available: %s)", deploy.LatestAppTemplateVersion)
}
if a.URI == "" {
a.URI = "N/A"
}
if a.PermissionsBoundary == "" {
a.PermissionsBoundary = "N/A"
}
fmt.Fprintf(writer, " %s\t%s %s\n", "Version", a.Version, availableVersion)
fmt.Fprintf(writer, " %s\t%s\n", "URI", a.URI)
Copy link
Copy Markdown
Contributor

@efekarakus efekarakus Oct 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated to your PR but I feel like we should rename this from "URI" to "Domain" in a separate PR

fmt.Fprintf(writer, " %s\t%s\n", "Permissions Boundary", a.PermissionsBoundary)
Comment thread
KollaAdithya marked this conversation as resolved.
fmt.Fprint(writer, color.Bold.Sprint("\nEnvironments\n\n"))
writer.Flush()
headers := []string{"Name", "AccountID", "Region"}
Expand Down