feat(develop): outbound-only new service flow #1050

bartoszmajsak · 2022-07-22T11:28:31Z

Short description of what this resolves:

Enables working on newly created service through ike develop new --name new-service -n namespace which takes care of creating all required k8s resources and then delegates the rest of the work to parent ike develop command. This work supports (and tests) service with outbound-only calls.

For the actual test of this new feature see fundamental_use_cases_test.go

Changes proposed in this pull request:

ike develop new subcommand
brings back the dynamic client to create necessary k8s resources on the fly
test services moved from strings to actual files which are then //go:embeded for easy on-the-fly manipulation
not passing argument to scenario generator results in listing all available options instead of just failing
restructures and rewords e2e test cases
- brakes down test files by areas
- moves verification funcs to new verify package
creates Printer func to abstract away how runtime.Objects are printed
- based on the "diagram work"
- enables dynamic client call when generating objects
minor cleanups
- rewords some godoc
- renames alphanumeric string generation func
- adds missing error handling
- removes unneeded if statement
- disables ginkgo verbose output - slightly faster test execution
- moves generator code to main pkg/

Fixes #1022

TODO

enable defining service image in generator
address admission webhook when creating new objects (this does not block the test from succeeding)
write tests for k8s dynamic client (part of feat: checks if operator exists for server-related cmds #1081)
mute cmd output in tests
give test scenarios better names (instead of scenario-1.1 for example)
update docs
- cli-get
- feature overview
test when gw does not exist

Open questions

when --name is not passed should it be autogenerated or is it required?
should we support "the very first service" scenario?

Carry-overs

do not create 2 deployments for new service - use --swap-deployment strategy instead

pkg/cmd/completion/cmd.go

Makefile

aslakknutsen · 2022-07-22T13:19:31Z

e2e/fundamental_use_cases_test.go

+
+				When("deploying new version of the service to the cluster", func() {
+
+					It("should deploy new instance of the service and make it reachable through special route", func() {


Should we reword these to "deploy updated instance/version" instead of using "new" to not confuse with "new service" ?

My thinking here was that I'm deploying new service, but I agree it should be reworded. I'll take care of it.

Does it sound better now? bf7471e

Not seeing the relevance? :)

I think that should be more relevant: f31d18c

pkg/cmd/develop/cmd.go

aslakknutsen · 2022-07-22T16:10:33Z

true is anyway default value to return so no need to evaluate this condition

Tests are poluting logs too much anyway. Default mode logs details on failures. In order to use verbose mode you can use `make test -v`

Opens Service entry creation to pass ports

…flags

aslakknutsen · 2022-09-01T09:00:04Z

Makefile


 .PHONY: test-e2e
 test-e2e: compile ## Runs end-to-end tests
 	$(call header,"Running end-to-end tests")
-	ginkgo e2e/ -r -v -progress -vet=off -trace --junit-report=ginkgo-test-results.xml ${args}
+	ginkgo e2e/ -r -progress -vet=off -trace --junit-report=ginkgo-test-results.xml ${args}


Didn't we add the -v to avoid the circle job to timeout with no output? Don't remember if that was successful or not

That was verbose mode and it resulted in very noisy output. For seeing what's going on -progress is enough. See latest build https://app.circleci.com/pipelines/github/maistra/istio-workspace/3476/workflows/9bd1b0db-2859-45d0-9cb5-bdc1975663b2/jobs/8767?invite=true#step-108-820

bartoszmajsak · 2022-11-16T13:37:08Z

/help

bartoszmajsak added kind/enhancement Kind: New feature or improvement component/cli Component: CLI tooling labels Jul 22, 2022

bartoszmajsak changed the title ~~new service~~ feat(develop): outbound-only new service flow Jul 22, 2022

bartoszmajsak requested a review from aslakknutsen July 22, 2022 11:53

bartoszmajsak commented Jul 22, 2022

View reviewed changes

pkg/cmd/completion/cmd.go Show resolved Hide resolved

aslakknutsen reviewed Jul 22, 2022

View reviewed changes

bartoszmajsak added 23 commits July 25, 2022 12:40

chore: removes unneeded if statement

ff628f3

true is anyway default value to return so no need to evaluate this condition

chore: rewords some godoc

05085f1

chore: renames alphanumeric string generation func

aba7f0c

chore: rewords e2e scenarios

35f5141

chore: restructured e2e test cases

d6e93d4

chore(e2e): restructures e2e tests

17bf2a2

feat: simple web service to use in new service scenario

0c4cfad

chore(test): disables ginkgo verbose output

155e043

Tests are poluting logs too much anyway. Default mode logs details on failures. In order to use verbose mode you can use `make test -v`

chore: adds error handling to new-service

7cc3db9

chore: handles error from bar.Add call

ea209cc

chore: moves generator code to main pkg/

93f7c6a

Opens Service entry creation to pass ports

chore(make): bumps Kustomize to latest release

c78c9df

chore: removes gomega dependency from non-test deployment.go

5e62d9c

feat(test): first cut on new-service test

5a75473

chore: attempts to limit cobra deps in session logic

e5cefa3

chore: renames TODO to FIX to make linter happy ;)

e6d9ba6

feat(new-service): crufty version of ike develop new

76854f3

chore(generator): uses entry ports instead of hardcoded ones

d02790a

chore(generator): renames Entry to ServiceEntry

44c3b23

fix(completion): scans all flags to build bash completion for custom …

9505818

…flags

chore: gofmt

ecce119

chore(e2e): deploys completion project right before ordered tests

23bef0a

fix(completion): validates argument

f221664

bartoszmajsak added 15 commits August 3, 2022 11:38

fix(e2e): ensures correct order of before hooks

444c980

chore: moves test services to their own folders

9cac73f

chore(make): pushes tagged and latest bundle

885e5c7

chore: renames model.Flip to Undo as it better explains the purpose

bcb872c

chore: prints available scenarios on failure

4e29b33

chore(e2e): do not stop already finished command

0072e11

chore(e2e): do not stop already finished command

c4c5f09

chore: fixes typos in gw locators

5273fe6

chore: enables gateway host definition for new service

8b38d46

chore: skips random suffix in service name generation

4b24bff

Merge branch 'master' into new_service

8c90dc8

Merge branch 'master' into new_service

c778a9d

fix: do not panic on SIGINT

d984504

feat: cleans up created resources on exit

c4e5d0e

fix: creates gateway for new deployment with single service

4edbee2

aslakknutsen reviewed Sep 1, 2022

View reviewed changes

bartoszmajsak added 2 commits September 14, 2022 15:06

Merge branch 'master' into new_service

d23b1c3

chore: rewords test cases of ike develop

f31d18c

bartoszmajsak marked this pull request as ready for review September 14, 2022 15:19

bartoszmajsak marked this pull request as draft September 14, 2022 15:21

bartoszmajsak added 5 commits September 16, 2022 16:39

Merge branch 'master' into new_service

45a1d9b

fix: resolves merge issues

6fe4d7f

fix: cleans up resources on error

971566e

fix: naming generator test has proper len

b99e2bb

fix: avoids leaking hook goroutine

c5214c6

bartoszmajsak force-pushed the new_service branch from 53338bb to c5214c6 Compare October 5, 2022 13:18

bartoszmajsak added 3 commits October 6, 2022 19:07

fix: extends timeouts in cmd tests

c3b4045

Merge branch 'master' into new_service

728c87f

Merge branch 'master' into new_service

afa2e6d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(develop): outbound-only new service flow #1050

feat(develop): outbound-only new service flow #1050

bartoszmajsak commented Jul 22, 2022 •

edited

Loading

aslakknutsen Jul 22, 2022

bartoszmajsak Jul 22, 2022

bartoszmajsak Aug 2, 2022 •

edited

Loading

aslakknutsen Aug 3, 2022

bartoszmajsak Sep 14, 2022

aslakknutsen commented Jul 22, 2022 •

edited

Loading

aslakknutsen Sep 1, 2022

bartoszmajsak Sep 2, 2022 •

edited

Loading

bartoszmajsak commented Nov 16, 2022


		When("deploying new version of the service to the cluster", func() {

		It("should deploy new instance of the service and make it reachable through special route", func() {

feat(develop): outbound-only new service flow #1050

Are you sure you want to change the base?

feat(develop): outbound-only new service flow #1050

Conversation

bartoszmajsak commented Jul 22, 2022 • edited Loading

Short description of what this resolves:

Changes proposed in this pull request:

TODO

Open questions

Carry-overs

aslakknutsen Jul 22, 2022

Choose a reason for hiding this comment

bartoszmajsak Jul 22, 2022

Choose a reason for hiding this comment

bartoszmajsak Aug 2, 2022 • edited Loading

Choose a reason for hiding this comment

aslakknutsen Aug 3, 2022

Choose a reason for hiding this comment

bartoszmajsak Sep 14, 2022

Choose a reason for hiding this comment

aslakknutsen commented Jul 22, 2022 • edited Loading

aslakknutsen Sep 1, 2022

Choose a reason for hiding this comment

bartoszmajsak Sep 2, 2022 • edited Loading

Choose a reason for hiding this comment

bartoszmajsak commented Nov 16, 2022

bartoszmajsak commented Jul 22, 2022 •

edited

Loading

bartoszmajsak Aug 2, 2022 •

edited

Loading

aslakknutsen commented Jul 22, 2022 •

edited

Loading

bartoszmajsak Sep 2, 2022 •

edited

Loading