Enhance egctl #1020

suchen-sci · 2023-06-26T06:03:50Z

No description provided.

codecov-commenter · 2023-06-26T06:27:31Z

Codecov Report

Patch coverage: 49.09% and project coverage change: -0.10 ⚠️

Comparison is base (2c257b1) 81.69% compared to head (7dfd1cc) 81.60%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1020      +/-   ##
==========================================
- Coverage   81.69%   81.60%   -0.10%     
==========================================
  Files         135      135              
  Lines       15044    15104      +60     
==========================================
+ Hits        12290    12325      +35     
- Misses       2197     2222      +25     
  Partials      557      557

Impacted Files	Coverage Δ
pkg/cluster/customdata/customdata.go	`74.30% <0.00%> (-8.52%)`	⬇️
pkg/cluster/layout.go	`95.23% <0.00%> (-4.77%)`	⬇️
pkg/object/autocertmanager/autocertmanager.go	`93.60% <100.00%> (+0.13%)`	⬆️
pkg/object/grpcserver/grpcserver.go	`100.00% <100.00%> (ø)`
pkg/object/httpserver/httpserver.go	`100.00% <100.00%> (ø)`
pkg/object/mqttproxy/mqttproxy.go	`50.00% <100.00%> (+3.16%)`	⬆️
pkg/object/pipeline/pipeline.go	`81.48% <100.00%> (+0.38%)`	⬆️

... and 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

cmd/client/commandv2/create.go

cmd/client/commandv2/general.go

README.md

localvar

please also fix github action warnings.
general, common, utils are all too general names, it is hard to guess their usages.

localvar · 2023-07-06T01:51:48Z

doc/egctl-cheat-sheet.md

+# egctl Cheat Sheet
+
+## Creating resources
+Easegress manifests are defined in YAML. The file extension .yaml and .yml be used. Use `egctl create`, or `egctl apply` to create resources. Use `egctl api-resources` to view all available resources and their supported actions. 


please use chatgpt to improve this file.

all updated, please check!

localvar · 2023-07-06T01:55:48Z

pkg/api/customdata.go

+ kinds, err := s.cds.ListKinds()
+ if err != nil {
+ ClusterPanic(err)
+ }
+
+ for _, k := range kinds {
+ err = s.cds.DeleteKind(k.Name)
+ if err != nil {
+ ClusterPanic(err)
+ }


this could be done via one etcd request, no need list and loops.

Good idea, i will update it now

xxx7xxxx · 2023-07-06T01:29:47Z

cmd/client/resources/member.go

+ // Output table:
+ // NAME ROLE AGE STATE API-ADDR HEARTBEAT
+ table := [][]string{}
+ table = append(table, []string{"NAME", "ROLE", "AGE", "STATE", "API-ADDR", "HEARTBEAT"})


"API ADDR" would be better (via k8s), and all other fields with multiple words.

Thanks for your advice. I check several k8s commands, I find some of them use seperate words(pod), some of them use "-" to connect words(node, deployment, svc). I am prefer "API-ADDR" over "API ADDR" because "API-ADDR" feel more like one word, and "API ADDR" feel more like two words. And when print table in terminal, sometimes two columns really close to each other, "API-ADDR" may feels better. So, it that ok to keep "API-ADDR"?

cd:➜ ~ |>k get svc -o wide | grep NAME [~] NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE SELECTOR cd:➜ ~ |>k get po -o wide | grep NAME [~] NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES cd:➜ ~ |>k get deploy -o wide | grep NAME [~] NAME READY UP-TO-DATE AVAILABLE AGE CONTAINERS IMAGES SELECTOR cd:➜ ~ |>k get node -o wide | grep NAME [~] NAME STATUS ROLES AGE VERSION INTERNAL-IP EXTERNAL-IP OS-IMAGE KERNEL-VERSION CONTAINER-RUNTIME

xxx7xxxx · 2023-07-06T01:44:57Z

README.md

@@ -224,7 +229,7 @@ https: false
 rules:
 - paths:
 - pathPrefix: /pipeline
- backend: pipeline-demo' | egctl object create
+ backend: pipeline-demo' | egctl create 


I was thinking if we should use more idiomatic egctl create|apply -f -

Good idea, i will update it now

I saw your demo not showing this usage, is it supported now?

Yes, user can create and apply resoruce from yaml file or stdin.

➜ easegress git:(enhance-egctl) ✗ cat httpserver.yaml | egctl create create HTTPServer httpserver successfully

I thought you will support egctl create -f -

Sorry for misunderstanding... Let me update it.

Updated, now egctl create -f - and egctl apply -f - is supported. egctl create/apply will print the help text. I also update related ducoments. Please check again.

➜ cat httpserver.yaml | egctl create -f - create HTTPServer httpserver successfully ➜ cat httpserver.yaml | egctl apply -f - update HTTPServer httpserver successfully ➜ egctl create Error: yaml file is required Usage: ... Examples: ... ... Error: yaml file is required

xxx7xxxx · 2023-07-06T01:49:35Z

cmd/client/command/utils.go

+ resp, body := doRequestV1(httpMethod, url, jsonBody, client, cmd)
+
+ msg := string(body)
+ if strings.HasPrefix(url, general.HTTPProtocol) && resp.StatusCode == http.StatusBadRequest && strings.Contains(strings.ToUpper(msg), "HTTPS") {


Server returns 400 if the protocol is wrong?

Here I actually reuse previous logic about updating protocol part. And I just do a test about it to make sure. The answer is yes. Golang http lib will return 400 if the protocol is wrong.

➜ easegress git:(enhance-egctl) ✗ curl http:https://localhost:2381/apis/v2 -v * Trying ::1... * TCP_NODELAY set * Connection failed * connect to ::1 port 2381 failed: Connection refused * Trying 127.0.0.1... * TCP_NODELAY set * Connected to localhost (127.0.0.1) port 2381 (#0) > GET /apis/v2 HTTP/1.1 > Host: localhost:2381 > User-Agent: curl/7.64.1 > Accept: */* > * HTTP 1.0, assume close after body < HTTP/1.0 400 Bad Request < Client sent an HTTP request to an HTTPS server. * Closing connection 0

xxx7xxxx · 2023-07-06T01:53:09Z

cmd/client/general/config.go

+ return "", err
+ }
+
+ return path.Join(homeDir, ".egctlconfig"), nil


.egctlrc would be more idiomatic

all updated, please check!

localvar · 2023-07-07T00:40:12Z

cmd/client/commandv2/apply.go

@@ -15,6 +15,7 @@
 * limitations under the License.
 */

+// Package commandv2 provides the new version of commands.


add comment to one file of a package could resolve the github action warning, no need to add the comment to all files.

however, as the comments have been added, it is ok to leave them there.

* finish get command and refactor code * finish describe object * finish all describe * finish create, delete, update * finish other command * add example framework * add more examples, add other missing commands * add command for object status * udpate egctl command * update * add comments * add more comments, add egctl cheat sheet * update egctl cheat sheet * fix random test bug * update based on comment * rewrite apply create get command * finish describe, delete and refactor code * update examples * fix typo * add security for egctl * update doc * refactor code structure * update based on code review comments * update based on github action * update based on github action * update based on github action * update based on github action * update based on github action * update based on github action * support egctl create/apply -f -

suchen-sci added 10 commits June 16, 2023 16:40

finish get command and refactor code

a755223

finish describe object

a118ed2

finish all describe

4c96e30

finish create, delete, update

84ab4c6

finish other command

5f9815a

add example framework

6a807fe

add more examples, add other missing commands

587e948

add command for object status

75219f6

udpate egctl command

9a74cf9

update

7d1f484

suchen-sci requested review from localvar and xxx7xxxx June 26, 2023 06:03

add comments

9f75742

suchen-sci added 3 commits June 26, 2023 15:15

add more comments, add egctl cheat sheet

7bc5634

update egctl cheat sheet

9d8063a

fix random test bug

a496d83

xxx7xxxx reviewed Jun 26, 2023

View reviewed changes

cmd/client/commandv2/create.go Outdated Show resolved Hide resolved

cmd/client/commandv2/general.go Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

update based on comment

86baec0

suchen-sci marked this pull request as draft June 28, 2023 04:31

suchen-sci added 7 commits June 29, 2023 18:03

rewrite apply create get command

599cd37

finish describe, delete and refactor code

bf84ef6

update examples

66d0089

Merge branch 'main' into enhance-egctl

e3169b9

fix typo

f4a1e84

add security for egctl

d62f266

update doc

d65c077

suchen-sci marked this pull request as ready for review July 5, 2023 10:27

localvar reviewed Jul 6, 2023

View reviewed changes

xxx7xxxx reviewed Jul 6, 2023

View reviewed changes

suchen-sci added 8 commits July 6, 2023 14:46

refactor code structure

cb58b43

update based on code review comments

f69ec13

update based on github action

14ebb75

update based on github action

7dfd1cc

update based on github action

83df91b

update based on github action

92f54a8

update based on github action

b8593fc

update based on github action

c4e92c4

suchen-sci requested review from localvar and xxx7xxxx July 6, 2023 09:46

localvar approved these changes Jul 7, 2023

View reviewed changes

support egctl create/apply -f -

6e81f67

xxx7xxxx approved these changes Jul 7, 2023

View reviewed changes

xxx7xxxx added this pull request to the merge queue Jul 7, 2023

Merged via the queue into easegress-io:main with commit cec32d6 Jul 7, 2023
7 checks passed

suchen-sci deleted the enhance-egctl branch July 7, 2023 03:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhance egctl #1020

Enhance egctl #1020

suchen-sci commented Jun 26, 2023

codecov-commenter commented Jun 26, 2023 •

edited

Loading

localvar left a comment

localvar Jul 6, 2023

suchen-sci Jul 6, 2023

localvar Jul 6, 2023

suchen-sci Jul 6, 2023

xxx7xxxx Jul 6, 2023

suchen-sci Jul 6, 2023

xxx7xxxx Jul 6, 2023

xxx7xxxx Jul 6, 2023

suchen-sci Jul 6, 2023

xxx7xxxx Jul 6, 2023

suchen-sci Jul 6, 2023

xxx7xxxx Jul 7, 2023

suchen-sci Jul 7, 2023

suchen-sci Jul 7, 2023

xxx7xxxx Jul 6, 2023

suchen-sci Jul 6, 2023

xxx7xxxx Jul 6, 2023

suchen-sci Jul 6, 2023

localvar Jul 7, 2023 •

edited

Loading

suchen-sci Jul 7, 2023

Enhance egctl #1020

Enhance egctl #1020

Conversation

suchen-sci commented Jun 26, 2023

codecov-commenter commented Jun 26, 2023 • edited Loading

Codecov Report

localvar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

localvar Jul 7, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented Jun 26, 2023 •

edited

Loading

localvar Jul 7, 2023 •

edited

Loading