feat: adds a func environment command

[lance]

Changes

• 🎁 Adds func environment to print the current function execution environment as JSON.

See: #1676

/kind enhancement

Example output

./func environment
{
  "Version": "v0.0.0",
  "GitRevision": "8a546005",
  "BuildDate": "20230530T212036Z",
  "SpecVersion": "0.35.0",
  "SocatImage": "quay.io/boson/alpine-socat:1.7.4.3-r1-non-root",
  "TarImage": "quay.io/boson/alpine-socat:1.7.4.3-r1-non-root",
  "Languages": [
    "go",
    "node",
    "python",
    "quarkus",
    "rust",
    "springboot",
    "typescript"
  ],
  "Templates": {
    "go": [
      "cloudevents",
      "http"
    ],
    "node": [
      "cloudevents",
      "http"
    ],
    "python": [
      "cloudevents",
      "flask",
      "http",
      "wsgi"
    ],
    "quarkus": [
      "cloudevents",
      "http"
    ],
    "rust": [
      "cloudevents",
      "http"
    ],
    "springboot": [
      "cloudevents",
      "http"
    ],
    "typescript": [
      "cloudevents",
      "http"
    ]
  },
  "Environment": [
    "FUNC_REGISTRY=quay.io/lanceball"
  ],
  "Cluster": "https://127.0.0.1:61315",
  "Defaults": {
    "Builder": "pack",
    "Confirm": false,
    "Language": "",
    "Namespace": "default",
    "Registry": "",
    "Verbose": false
  }
}

Release Note

Adds `func environment` to print the current function execution environment as JSON.

[codecov]

Codecov Report

Patch coverage: 21.35% and project coverage change: +1.93 🎉

Comparison is base (2656a7e) 60.34% compared to head (0e95f6a) 62.27%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1761      +/-   ##
==========================================
+ Coverage   60.34%   62.27%   +1.93%     
==========================================
  Files          98      100       +2     
  Lines       13205    13311     +106     
==========================================
+ Hits         7969     8290     +321     
+ Misses       4456     4226     -230     
- Partials      780      795      +15     

Flag	Coverage Δ
e2e-test	37.95% <21.35%> (-0.14%)	⬇️
e2e-test-oncluster	33.51% <21.35%> (-0.10%)	⬇️
e2e-test-oncluster-runtime	28.81% <21.35%> (?)
e2e-test-runtime-go	27.37% <21.35%> (?)
e2e-test-runtime-node	28.53% <21.35%> (?)
e2e-test-runtime-python	28.53% <21.35%> (?)
e2e-test-runtime-quarkus	28.66% <21.35%> (?)
e2e-test-runtime-springboot	27.61% <21.35%> (?)
e2e-test-runtime-typescript	28.66% <21.35%> (?)
integration-tests	47.98% <21.35%> (?)
unit-tests-macos-latest	49.29% <21.35%> (?)
unit-tests-ubuntu-latest	50.08% <21.35%> (?)
unit-tests-windows-latest	49.34% <21.35%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
cmd/environment.go	20.58% <20.58%> (ø)
cmd/root.go	79.56% <100.00%> (+0.08%)	⬆️

... and 19 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.

[lance]

The code style errors are catching the SuggestFor values which are deliberately misspelled.

/override "style / Golang / Lint"

[knative-prow]

@lance: Overrode contexts on behalf of lance: style / Golang / Lint

In response to this:

The code style errors are catching the SuggestFor values which are deliberately misspelled.

/override "style / Golang / Lint"

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[lance]

/override "style / suggester / shell"
/override "style / suggester / yaml"
/override "style / suggester / github_actions"

[knative-prow]

@lance: Overrode contexts on behalf of lance: style / suggester / github_actions, style / suggester / shell, style / suggester / yaml

In response to this:

/override "style / suggester / shell"
/override "style / suggester / yaml"
/override "style / suggester / github_actions"

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[lkingland]

This /lgtm!

/hold for anyone else to perhaps comment, but seems to me this is a great place to start iterating if we think of anything else to add, etc.

[jrangelramos]

it looks good to me. Maybe one very small cosmetic suggestion would be not printing null.. i.e. when no func env var is defined.
Currently it prints

"Environment": null,

what about?

"Environment": [],

but this is cosmetic..

[jrangelramos]

It might be a bit late for this PR (maybe for another).. but what about a -o [json|yaml|human|jsonpath] option?
That would be cool seeing this in other formats (more human readable) following kn, podman, oc` and other cli standards..

For example, an human readable could look like

$ ./func environment -o human
* Build and Version Info
  Func Version     : v0.0.0
  Build / Git Rev  : fefea2b6
  Spec Version     : 0.35.0

* Images 
  SocatImage       : quay.io/boson/alpine-socat:1.7.4.3-r1-non-root
  TarImage         : quay.io/boson/alpine-socat:1.7.4.3-r1-non-root

* Environment Variables
  FUNC_REGISTRY    : quay.io/lanceball

Target Cluster     : https://127.0.0.1:61315

* CLI Defaults
  Builder          : pack
  Confirm          : false
  Language         : 
  Namespace        : default
  Registry         : 
  Verbose Mode     : false

* Supported Runtimes
  go, node, python, quarkus, rust, springboot, typescript

* Templates
  go          cloudevents, http
  python      cloudevents, http
  quarkus     cloudevents, http
  springboot  cloudevents, http
  rust        cloudevents, http
  typescript  cloudevents, http
  node        cloudevents, http

[lance]

@jrangelramos I assumed that would follow in a subsequent PR and have that as a TODO here: https://github.com/knative/func/pull/1761/files#diff-307b508c3eb9b3182cd02cbf3b681ab8f07937ce80be379fdd361bc9c5387d80R154

Seems like it could be a good-first-issue, no?

[lance]

@jrangelramos @matejvasek thanks for the feedback; I've incorporated it (for additional output formats, I will create an Issue).

[matejvasek]

/approve
/lgtm

[knative-prow]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lance, lkingland, matejvasek

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [lance,lkingland,matejvasek]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[matejvasek]

/unhold

[matejvasek]

@lance you need to override the linter.

[lance]

/override "style / Golang / Lint

[knative-prow]

@lance: Overrode contexts on behalf of lance: style / Golang / Lint

In response to this:

/override "style / Golang / Lint

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[lance]

/cherry-pick release-1.10

[knative-prow-robot]

@lance: new pull request created: #1848

In response to this:

/cherry-pick release-1.10

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.