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

Add events to indicate start and end of skaffold dev iterations #4037

Merged
merged 9 commits into from
May 5, 2020
Merged

Add events to indicate start and end of skaffold dev iterations #4037

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
5ec9838
Add to indicate start and end of skaffold dev iterations
tejal29 Apr 28, 2020
ffb0ef8
Add ActionableErr proto to DevLoop Event
tejal29 Apr 29, 2020
56ebbaa
Add test for dev loop entries
tejal29 Apr 29, 2020
75fe5a9
add more information for proto marshall error
tejal29 Apr 29, 2020
9cb82be
add skaffold end session event
tejal29 Apr 30, 2020
735e963
Revert "add skaffold end session event"
tejal29 May 1, 2020
9a2f0ff
brians's comments
tejal29 May 4, 2020
6411b4d
fix diag
tejal29 May 4, 2020
835291c
revert to master
tejal29 May 5, 2020
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
359 changes: 248 additions & 111 deletions docs/content/en/api/skaffold.swagger.json
View file
Open in desktop

Large diffs are not rendered by default.

94 changes: 70 additions & 24 deletions docs/content/en/docs/references/api/grpc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ If the build fails, an error will be attached to the event.
| artifact | [string](#string) | | artifact name |
| status | [string](#string) | | artifact build status oneof: InProgress, Completed, Failed |
| err | [string](#string) | | error when build status is Failed. |
| errCode | [ErrorCode](#proto.ErrorCode) | | error code representing the error |
| statusCode | [StatusCode](#proto.StatusCode) | | status code representing success or failure |



Expand Down Expand Up @@ -197,7 +197,7 @@ anytime a deployment starts or completes, successfully or not.
| ----- | ---- | ----- | ----------- |
| status | [string](#string) | | deployment status oneof: InProgress, Completed, Failed |
| err | [string](#string) | | error when status is Failed |
| errCode | [ErrorCode](#proto.ErrorCode) | | error code representing the error |
| statusCode | [StatusCode](#proto.StatusCode) | | status code representing success or failure |



Expand Down Expand Up @@ -252,6 +252,39 @@ anytime a deployment starts or completes, successfully or not.



<a name="proto.DevLoopEvent"></a>
#### DevLoopEvent
`DevLoopEvent` marks the start and end of a dev loop.


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| iteration | [int32](#int32) | | dev loop iteration. 0 represents initialization loop. |
| status | [string](#string) | | dev loop status oneof: In Progress, Completed, Failed |
| err | [ErrDef](#proto.ErrDef) | | actionable error message |







<a name="proto.ErrDef"></a>
#### ErrDef
`ErrDef` defines an error occurred along with an optional suggestions


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| errCode | [StatusCode](#proto.StatusCode) | | error code representing the error |
| message | [string](#string) | | message describing the error. |







<a name="proto.Event"></a>
#### Event
`Event` describes an event in the Skaffold process.
Expand All @@ -268,6 +301,7 @@ It is one of MetaEvent, BuildEvent, DeployEvent, PortEvent, StatusCheckEvent, Re
| resourceStatusCheckEvent | [ResourceStatusCheckEvent](#proto.ResourceStatusCheckEvent) | | indicates progress for each kubernetes deployment. |
| fileSyncEvent | [FileSyncEvent](#proto.FileSyncEvent) | | describes the sync status. |
| debuggingContainerEvent | [DebuggingContainerEvent](#proto.DebuggingContainerEvent) | | describes the appearance or disappearance of a debugging container |
| devLoopEvent | [DevLoopEvent](#proto.DevLoopEvent) | | describes a start and end of a dev loop. |



Expand All @@ -286,7 +320,7 @@ FileSyncEvent describes the sync status.
| image | [string](#string) | | the container image to which files are sycned. |
| status | [string](#string) | | status of file sync. one of: Not Started, In progress, Succeeded, Failed. |
| err | [string](#string) | | error in case of status failed. |
| errCode | [ErrorCode](#proto.ErrorCode) | | error code representing the error |
| statusCode | [StatusCode](#proto.StatusCode) | | status code representing success or failure |



Expand Down Expand Up @@ -529,7 +563,7 @@ will be sent with the new status.
| status | [string](#string) | | |
| message | [string](#string) | | |
| err | [string](#string) | | |
| errCode | [ErrorCode](#proto.ErrorCode) | | error code representing the error |
| statusCode | [StatusCode](#proto.StatusCode) | | status code representing success or failure |



Expand Down Expand Up @@ -644,30 +678,42 @@ Enum indicating deploy tools used



<a name="proto.ErrorCode"></a>
<a name="proto.StatusCode"></a>

### ErrorCode
Enum for error codes
### StatusCode
Enum for Status codes
These error codes are prepended by Phase Name e.g.
BUILD, DEPLOY, STATUSCHECK, DEVINIT

| Name | Number | Description |
| ---- | ------ | ----------- |
| COULD_NOT_DETERMINE | 0 | Could not determine error |
| STATUS_CHECK_NO_ERROR | 200 | Status Check Success |
| STATUS_CHECK_IMAGE_PULL_ERR | 300 | Container image pull error |
| STATUS_CHECK_CONTAINER_CREATING | 301 | Container creating error |
| STATUS_CHECK_RUN_CONTAINER_ERR | 302 | Container run error |
| STATUS_CHECK_CONTAINER_TERMINATED | 303 | Container is already terminated |
| STATUS_CHECK_CONTAINER_RESTARTING | 356 | Container restarting error |
| STATUS_CHECK_NODE_MEMORY_PRESSURE | 400 | Node memory pressure error |
| STATUS_CHECK_NODE_DISK_PRESSURE | 401 | Node disk pressure error |
| STATUS_CHECK_NODE_NETWORK_UNAVAILABLE | 402 | Node network unavailable error |
| STATUS_CHECK_NODE_PID_PRESSURE | 403 | Node PID pressure error |
| STATUS_CHECK_NODE_UNSCHEDULABLE | 404 | Node unschedulable error |
| STATUS_CHECK_NODE_UNREACHABLE | 405 | Node unreachable error |
| STATUS_CHECK_NODE_NOT_READY | 406 | Node not ready error |
| STATUS_CHECK_UNKNOWN | 501 | Status Check error unknown |
| STATUS_CHECK_UNKNOWN_UNSCHEDULABLE | 502 | Container is unschedulable due to unknown reasons |
| STATUS_CHECK_CONTAINER_WAITING_UNKNOWN | 503 | Container is waiting due to unknown reason |
| UNKNOWN_ERROR | 0 | Could not determine error and phase |
| STATUSCHECK_SUCCESS | 200 | Status Check Success |
| STATUSCHECK_IMAGE_PULL_ERR | 300 | Container image pull error |
| STATUSCHECK_CONTAINER_CREATING | 301 | Container creating error |
| STATUSCHECK_RUN_CONTAINER_ERR | 302 | Container run error |
| STATUSCHECK_CONTAINER_TERMINATED | 303 | Container is already terminated |
| STATUSCHECK_CONTAINER_RESTARTING | 356 | Container restarting error |
| STATUSCHECK_NODE_MEMORY_PRESSURE | 400 | Node memory pressure error |
| STATUSCHECK_NODE_DISK_PRESSURE | 401 | Node disk pressure error |
| STATUSCHECK_NODE_NETWORK_UNAVAILABLE | 402 | Node network unavailable error |
| STATUSCHECK_NODE_PID_PRESSURE | 403 | Node PID pressure error |
| STATUSCHECK_NODE_UNSCHEDULABLE | 404 | Node unschedulable error |
| STATUSCHECK_NODE_UNREACHABLE | 405 | Node unreachable error |
| STATUSCHECK_NODE_NOT_READY | 406 | Node not ready error |
| STATUSCHECK_UNKNOWN | 501 | Status Check error unknown |
| STATUSCHECK_UNKNOWN_UNSCHEDULABLE | 502 | Container is unschedulable due to unknown reasons |
| STATUSCHECK_CONTAINER_WAITING_UNKNOWN | 503 | Container is waiting due to unknown reason |
| DEPLOY_UNKNOWN | 504 | Deploy failed due to unknown reason |
| SYNC_UNKNOWN | 505 | SYNC failed due to known reason |
| BUILD_UNKNOWN | 506 | Build failed due to unknown reason |
| DEVINIT_UNKNOWN | 507 | Dev Init failed due to unknown reason |
| CLEANUP_UNKNOWN | 508 | Cleanup failed due to unknown reason |
| SYNC_INIT_ERROR | 601 | File Sync Initialize failure |
| DEVINIT_REGISTER_BUILD_DEPS | 701 | Failed to configure watcher for build dependencies in dev loop |
| DEVINIT_REGISTER_TEST_DEPS | 702 | Failed to configure watcher for test dependencies in dev loop |
| DEVINIT_REGISTER_DEPLOY_DEPS | 703 | Failed to configure watcher for deploy dependencies in dev loop |
| DEVINIT_REGISTER_CONFIG_DEP | 704 | Failed to configure watcher for Skaffold configuration file. |


<!-- end enums -->
Expand Down
25 changes: 18 additions & 7 deletions integration/rpc_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ import (
var (
connectionRetries = 2
readRetries = 20
numLogEntries = 5
numLogEntries = 7
waitTime = 1 * time.Second
)

Expand Down Expand Up @@ -111,7 +111,7 @@ func TestEventsRPC(t *testing.T) {
break
}
}
metaEntries, buildEntries, deployEntries := 0, 0, 0
metaEntries, buildEntries, deployEntries, devLoopEntries := 0, 0, 0, 0
for _, entry := range logEntries {
switch entry.Event.GetEventType().(type) {
case *proto.Event_MetaEvent:
Expand All @@ -123,14 +123,18 @@ func TestEventsRPC(t *testing.T) {
case *proto.Event_DeployEvent:
deployEntries++
t.Logf("deploy event %d: %v", deployEntries, entry.Event)
case *proto.Event_DevLoopEvent:
devLoopEntries++
t.Logf("devloop event event %d: %v", devLoopEntries, entry.Event)
default:
tejal29 marked this conversation as resolved.
Show resolved Hide resolved
t.Logf("unknown event: %v", entry.Event)
}
}
// make sure we have exactly 1 meta entry, 2 deploy entries and 2 build entries
// make sure we have exactly 1 meta entry, 2 deploy entries and 2 build entries and 2 devLoopEntries
testutil.CheckDeepEqual(t, 1, metaEntries)
testutil.CheckDeepEqual(t, 2, deployEntries)
testutil.CheckDeepEqual(t, 2, buildEntries)
testutil.CheckDeepEqual(t, 2, devLoopEntries)
}

func TestEventLogHTTP(t *testing.T) {
Expand Down Expand Up @@ -187,7 +191,7 @@ func TestEventLogHTTP(t *testing.T) {
entryStr = strings.Replace(entryStr, "{\"result\":", "", 1)
entryStr = entryStr[:len(entryStr)-1]
if err := jsonpb.UnmarshalString(entryStr, &entry); err != nil {
t.Errorf("error converting http response to proto: %s", err.Error())
t.Errorf("error converting http response %s to proto: %s", entryStr, err.Error())
}
numEntries++
logEntries = append(logEntries, entry)
Expand All @@ -197,22 +201,30 @@ func TestEventLogHTTP(t *testing.T) {
}
}

metaEntries, buildEntries, deployEntries := 0, 0, 0
metaEntries, buildEntries, deployEntries, devLoopEntries := 0, 0, 0, 0
for _, entry := range logEntries {
switch entry.Event.GetEventType().(type) {
case *proto.Event_MetaEvent:
metaEntries++
t.Logf("meta event %d: %v", metaEntries, entry.Event)
case *proto.Event_BuildEvent:
buildEntries++
t.Logf("build event %d: %v", buildEntries, entry.Event)
case *proto.Event_DeployEvent:
deployEntries++
t.Logf("deploy event %d: %v", deployEntries, entry.Event)
case *proto.Event_DevLoopEvent:
devLoopEntries++
t.Logf("devloop event event %d: %v", devLoopEntries, entry.Event)
default:
tejal29 marked this conversation as resolved.
Show resolved Hide resolved
t.Logf("unknown event: %v", entry.Event)
}
}
// make sure we have exactly 1 meta entry, 2 deploy entries and 2 build entries
// make sure we have exactly 1 meta entry, 2 deploy entries, 2 build entries and 2 devLoopEntries
testutil.CheckDeepEqual(t, 1, metaEntries)
testutil.CheckDeepEqual(t, 2, deployEntries)
testutil.CheckDeepEqual(t, 2, buildEntries)
testutil.CheckDeepEqual(t, 2, devLoopEntries)
})
}
}
Expand Down Expand Up @@ -341,7 +353,6 @@ func setupSkaffoldWithArgs(t *testing.T, args ...string) {
// start a skaffold dev loop on an example
ns, _ := SetupNamespace(t)

// Disable caching to ensure we get a "build in progress" event each time.
skaffold.Dev(append([]string{"--cache-artifacts=false"}, args...)...).InDir("testdata/dev").InNs(ns.Name).RunBackground(t)

t.Cleanup(func() {
Expand Down
Loading