Skip to content
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

Jump to bottom

Make actions plan preview handle timeout option #4648

Merged
merged 5 commits into from
Nov 13, 2023
Merged

Make actions plan preview handle timeout option #4648

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
058ae4d
Format and make tests pass in tool/actions-plan-preview
mi11km Nov 2, 2023
e7ab613
Use --piped-handle-timeout to make the timeout arg activate
mi11km Nov 2, 2023
5fef6cb
Add tests to model/notificationevent (#4631)
kentakozuka Nov 2, 2023
d0cb1a5
add piped-handle-timeout(input args)
mi11km Nov 13, 2023
089ed48
Merge branch 'master' into make-actions-plan-preview-handle-timeout-o…
khanhtc1202 Nov 13, 2023
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
32 changes: 22 additions & 10 deletions tool/actions-plan-preview/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,12 @@ const (
commentEventName = "issue_comment"
pushEventName = "push"

argAddress = "address"
argAPIKey = "api-key"
argToken = "token"
argTimeout = "timeout"
argPRNum = "pull-request-number"
argAddress = "address"
argAPIKey = "api-key"
argToken = "token"
argTimeout = "timeout"
argPipedHandleTimeout = "piped-handle-timeout"
argPRNum = "pull-request-number"
)

func main() {
Expand Down Expand Up @@ -121,6 +122,7 @@ func main() {
args.Address,
args.APIKey,
args.Timeout,
args.PipedHandleTimeout,
)
if err != nil {
doComment(failureBadgeURL + "\nUnable to run plan-preview. \ncause: " + err.Error())
Expand Down Expand Up @@ -172,11 +174,12 @@ func main() {
}

type arguments struct {
Address string
APIKey string
Token string
Timeout time.Duration
PRNum int
Address string
APIKey string
Token string
Timeout time.Duration
PipedHandleTimeout time.Duration
PRNum int
}

func parseArgs(args []string) (arguments, error) {
Expand All @@ -200,6 +203,12 @@ func parseArgs(args []string) (arguments, error) {
return arguments{}, err
}
out.Timeout = d
case argPipedHandleTimeout:
d, err := time.ParseDuration(ps[1])
if err != nil {
return arguments{}, err
}
out.PipedHandleTimeout = d
case argPRNum:
if ps[1] == "" {
continue
Expand Down Expand Up @@ -227,6 +236,9 @@ func parseArgs(args []string) (arguments, error) {
if out.Timeout == 0 {
out.Timeout = defaultTimeout
}
if out.PipedHandleTimeout == 0 {
out.PipedHandleTimeout = defaultTimeout
}

return out, nil
}
Expand Down
134 changes: 134 additions & 0 deletions tool/actions-plan-preview/main_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,11 @@ package main

import (
"embed"
"fmt"
"testing"
"time"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

Expand All @@ -33,3 +36,134 @@ func readTestdataFile(t *testing.T, name string) []byte {
func boolPointer(b bool) *bool {
return &b
}

func Test_parseArgs(t *testing.T) {
type args struct {
args []string
}
tests := []struct {
name string
args args
want arguments
wantErr assert.ErrorAssertionFunc
}{
{
name: "minimum required args with no error",
args: args{
args: []string{
"address=localhost:8080",
"api-key=xxxxxxxxxxxxxx",
"token=xxxxxxxxxxxxxxxx",
},
},
want: arguments{
Address: "localhost:8080",
APIKey: "xxxxxxxxxxxxxx",
Token: "xxxxxxxxxxxxxxxx",
Timeout: defaultTimeout,
PipedHandleTimeout: defaultTimeout,
},
wantErr: assert.NoError,
},
{
name: "minimum required args and specified timeout arg with no error",
args: args{
args: []string{
"address=localhost:8080",
"api-key=xxxxxxxxxxxxxx",
"token=xxxxxxxxxxxxxxxx",
"timeout=10m",
},
},
want: arguments{
Address: "localhost:8080",
APIKey: "xxxxxxxxxxxxxx",
Token: "xxxxxxxxxxxxxxxx",
Timeout: 10 * time.Minute,
PipedHandleTimeout: defaultTimeout,
},
wantErr: assert.NoError,
},
{
name: "minimum required args and specified piped-handle-timeout arg with no error",
args: args{
args: []string{
"address=localhost:8080",
"api-key=xxxxxxxxxxxxxx",
"token=xxxxxxxxxxxxxxxx",
"piped-handle-timeout=10m",
},
},
want: arguments{
Address: "localhost:8080",
APIKey: "xxxxxxxxxxxxxx",
Token: "xxxxxxxxxxxxxxxx",
Timeout: defaultTimeout,
PipedHandleTimeout: 10 * time.Minute,
},
wantErr: assert.NoError,
},
{
name: "minimum required args and specified timeout and piped-handle-timeout arg with no error",
args: args{
args: []string{
"address=localhost:8080",
"api-key=xxxxxxxxxxxxxx",
"token=xxxxxxxxxxxxxxxx",
"timeout=12m",
"piped-handle-timeout=15m",
},
},
want: arguments{
Address: "localhost:8080",
APIKey: "xxxxxxxxxxxxxx",
Token: "xxxxxxxxxxxxxxxx",
Timeout: 12 * time.Minute,
PipedHandleTimeout: 15 * time.Minute,
},
wantErr: assert.NoError,
},
{
name: "missing required args (address) returns error",
args: args{
args: []string{
"api-key=xxxxxxxxxxxxxx",
"token=xxxxxxxxxxxxxxxx",
},
},
want: arguments{},
wantErr: assert.Error,
},
{
name: "missing required args (api-key) returns error",
args: args{
args: []string{
"address=localhost:8080",
"token=xxxxxxxxxxxxxxxx",
},
},
want: arguments{},
wantErr: assert.Error,
},
{
name: "missing required args (token) returns error",
args: args{
args: []string{
"address=localhost:8080",
"api-key=xxxxxxxxxxxxxx",
},
},
want: arguments{},
wantErr: assert.Error,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := parseArgs(tt.args.args)
if tt.wantErr(t, err, fmt.Sprintf("parseArgs(%v)", tt.args.args)) {
return
}
assert.Equalf(t, tt.want, got, "parseArgs(%v)", tt.args.args)
})
}
}
2 changes: 2 additions & 0 deletions tool/actions-plan-preview/planpreview.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ func retrievePlanPreview(
address,
apiKey string,
timeout time.Duration,
pipedHandleTimeout time.Duration,
) (*PlanPreviewResult, error) {

dir, err := os.MkdirTemp("", "")
Expand All @@ -101,6 +102,7 @@ func retrievePlanPreview(
"--address", address,
"--api-key", apiKey,
"--timeout", timeout.String(),
"--piped-handle-timeout", pipedHandleTimeout.String(),
"--out", outPath,
}
cmd := exec.CommandContext(ctx, "pipectl", args...)
Expand Down
7 changes: 4 additions & 3 deletions tool/actions-plan-preview/testdata/comment-has-failed-app.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@

Ran plan-preview against head commit abc of this pull request. PipeCD detected `1` updated applications and here are their plan results. Once this pull request got merged their deployments will be triggered to run as these estimations.

## app: [app-name-1](app-url-1), env: env-1, kind: app-kind-1
## Plans

### app: [app-name-1](app-url-1), env: env-1, kind: app-kind-1
Sync strategy: PIPELINE
Summary: plan-summary-1

Expand All @@ -17,12 +19,11 @@ plan-details-1
</p>
</details>

---

## NOTE

**An error occurred while building plan-preview for the following applications**

## app: [app-name-2](app-url-2), env: env-2, kind: app-kind-2
### app: [app-name-2](app-url-2), env: env-2, kind: app-kind-2
Reason: reason-2

7 changes: 4 additions & 3 deletions tool/actions-plan-preview/testdata/comment-has-failed-piped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@

Ran plan-preview against head commit abc of this pull request. PipeCD detected `1` updated applications and here are their plan results. Once this pull request got merged their deployments will be triggered to run as these estimations.

## app: [app-name-1](app-url-1), env: env-1, kind: app-kind-1
## Plans

### app: [app-name-1](app-url-1), env: env-1, kind: app-kind-1
Sync strategy: PIPELINE
Summary: plan-summary-1

Expand All @@ -17,12 +19,11 @@ plan-details-1
</p>
</details>

---

## NOTE

**An error occurred while building plan-preview for applications of the following Pipeds**

## piped: [piped-id-1](piped-url-1)
### piped: [piped-id-1](piped-url-1)
Reason: piped-reason-1

6 changes: 4 additions & 2 deletions tool/actions-plan-preview/testdata/comment-has-no-diff-apps.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@

Ran plan-preview against head commit abc of this pull request. PipeCD detected `3` updated applications and here are their plan results. Once this pull request got merged their deployments will be triggered to run as these estimations.

## app: [app-name-1](app-url-1), env: env-1, kind: app-kind-1
## Plans

### app: [app-name-1](app-url-1), env: env-1, kind: app-kind-1
Sync strategy: PIPELINE
Summary: plan-summary-1

Expand All @@ -17,7 +19,7 @@ plan-details-1
</p>
</details>

## No resource changes were detected but the following apps will also be triggered
### No resource changes were detected but the following apps will also be triggered

###### `PIPELINE`

Expand Down
5 changes: 4 additions & 1 deletion tool/actions-plan-preview/testdata/comment-no-env.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@

Ran plan-preview against head commit abc of this pull request. PipeCD detected `1` updated applications and here are their plan results. Once this pull request got merged their deployments will be triggered to run as these estimations.

## app: [app-name-1](app-url-1), kind: app-kind-1
## Plans

### app: [app-name-1](app-url-1), kind: app-kind-1
Sync strategy: PIPELINE
Summary: plan-summary-1

Expand All @@ -16,3 +18,4 @@ plan-details-1
```
</p>
</details>

5 changes: 4 additions & 1 deletion tool/actions-plan-preview/testdata/comment-only-changed-app.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@

Ran plan-preview against head commit abc of this pull request. PipeCD detected `1` updated applications and here are their plan results. Once this pull request got merged their deployments will be triggered to run as these estimations.

## app: [app-name-1](app-url-1), env: env-1, kind: app-kind-1
## Plans

### app: [app-name-1](app-url-1), env: env-1, kind: app-kind-1
Sync strategy: PIPELINE
Summary: plan-summary-1

Expand All @@ -16,3 +18,4 @@ plan-details-1
```
</p>
</details>

Loading