Align eval output with render #1907

Shell32-Natsu · 2021-05-05T19:46:26Z

Align the output of fn eval with fn render.

Example output:

$ kpt fn eval --image gcr.io/kpt-fn/set-namespace:v0.1 -- namespace=staging
[RUNNING] "gcr.io/kpt-fn/set-namespace:v0.1"
[PASS] "gcr.io/kpt-fn/set-namespace:v0.1"

$ kpt fn eval --image gcr.io/kpt-fn/set-namespace:v0.1
[RUNNING] "gcr.io/kpt-fn/set-namespace:v0.1"
[FAIL] "gcr.io/kpt-fn/set-namespace:v0.1"
  Stderr:
    "failed to configure function: input namespace cannot be empty"
  Exit Code: 1

$ kpt fn source | kpt fn eval - --image gcr.io/kpt-fn/set-namespace:v0.1 -- namespace=staging
# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
apiVersion: apps/v1
kind: Deployment
metadata:
...

$ kpt fn eval --image gcr.io/kpt-fn/set-namespace:v0.1 --dry-run -- namespace=staging
# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
apiVersion: apps/v1
kind: Deployment
metadata:
...

$ kpt fn eval --image gcr.io/kpt-fn/kubeval:v0.1
[RUNNING] "gcr.io/kpt-fn/kubeval:v0.1"
[FAIL] "gcr.io/kpt-fn/kubeval:v0.1"
  Stderr:
    "[ERROR] Failed to parse raw kubeval output:"
    "Unexpected token E in JSON at position 0"
    ""
    "ERR  - stdin: Failed initializing schema file:///tmp/master-standalone/deploymen-apps-v1.json: open /tmp/master-standalone/deploymen-apps-v1.json: no such file or directory"
    ...(2 line(s) truncated)
  Exit Code: 1

$ kpt fn eval --image gcr.io/kpt-fn/kubeval:v0.1 --truncate-output=false
[RUNNING] "gcr.io/kpt-fn/kubeval:v0.1"
[FAIL] "gcr.io/kpt-fn/kubeval:v0.1"
  Stderr:
    "[ERROR] Failed to parse raw kubeval output:"
    "Unexpected token E in JSON at position 0"
    ""
    "ERR  - stdin: Failed initializing schema file:///tmp/master-standalone/deploymen-apps-v1.json: open /tmp/master-standalone/deploymen-apps-v1.json: no such file or directory"
    " in object 'apps/v1/Deploymen//my-nginx' in file deployment.yaml"
    ""
  Exit Code: 1

close #1861

frankfarzan · 2021-05-05T21:18:27Z

Align the output of fn eval with fn render.

Example output:

$ kpt fn eval --image gcr.io/kpt-fn/set-namespace:v0.1 -- namespace=staging
[RUNNING] "gcr.io/kpt-fn/set-namespace:v0.1"
[PASS] "gcr.io/kpt-fn/set-namespace:v0.1"

$ kpt fn eval --image gcr.io/kpt-fn/set-namespace:v0.1
[RUNNING] "gcr.io/kpt-fn/set-namespace:v0.1"
[FAIL] "gcr.io/kpt-fn/set-namespace:v0.1"
  Stderr:
    "failed to configure function: input namespace cannot be empty"
  Exit Code: 1

$ kpt fn source | kpt fn eval - --image gcr.io/kpt-fn/set-namespace:v0.1 -- namespace=staging

Why does this show the resources instead of the PASS/FAIL? Per discussion, we need a document
on how render and fn will work when piped.

# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
apiVersion: apps/v1
kind: Deployment
metadata:
...

$ kpt fn eval --image gcr.io/kpt-fn/set-namespace:v0.1 --dry-run -- namespace=staging
# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
apiVersion: apps/v1
kind: Deployment
metadata:
...

$ kpt fn eval --image gcr.io/kpt-fn/kubeval:v0.1
[RUNNING] "gcr.io/kpt-fn/kubeval:v0.1"
[FAIL] "gcr.io/kpt-fn/kubeval:v0.1"
  Stderr:
    "[ERROR] Failed to parse raw kubeval output:"
    "Unexpected token E in JSON at position 0"
    ""
    "ERR  - stdin: Failed initializing schema file:///tmp/master-standalone/deploymen-apps-v1.json: open /tmp/master-standalone/deploymen-apps-v1.json: no such file or directory"
    ...(2 line(s) truncated)
  Exit Code: 1

$ kpt fn eval --image gcr.io/kpt-fn/kubeval:v0.1 --truncate-output=false
[RUNNING] "gcr.io/kpt-fn/kubeval:v0.1"
[FAIL] "gcr.io/kpt-fn/kubeval:v0.1"
  Stderr:
    "[ERROR] Failed to parse raw kubeval output:"
    "Unexpected token E in JSON at position 0"
    ""
    "ERR  - stdin: Failed initializing schema file:///tmp/master-standalone/deploymen-apps-v1.json: open /tmp/master-standalone/deploymen-apps-v1.json: no such file or directory"
    " in object 'apps/v1/Deploymen//my-nginx' in file deployment.yaml"
    ""
  Exit Code: 1

close #1861

Shell32-Natsu · 2021-05-05T21:35:00Z

Why does this show the resources instead of the PASS/FAIL? Per discussion, we need a document
on how render and fn will work when piped.

The output destination here is controlled by - and it's added in #1710. So actually fn eval doesn't know is it in a pipeline but read from stdin and write to stdout if there is an argument -.

frankfarzan · 2021-05-05T21:39:38Z

Why does this show the resources instead of the PASS/FAIL? Per discussion, we need a document
on how render and fn will work when piped.

The output destination here is controlled by - and it's added in #1710. So actually fn eval doesn't know is it in a pipeline but read from stdin and write to stdout if there is an argument -.

- controls reading from stdin, not necessarily the output behavior.

Shell32-Natsu · 2021-05-05T21:46:48Z

Why does this show the resources instead of the PASS/FAIL? Per discussion, we need a document
on how render and fn will work when piped.

The output destination here is controlled by - and it's added in #1710. So actually fn eval doesn't know is it in a pipeline but read from stdin and write to stdout if there is an argument -.

- controls reading from stdin, not necessarily the output behavior.

Makes sense, but controlling both reading from stdin and writing to stdout keeps consistent with fn run. fn run will read from stdin and write to stdout if no directory specified.

droot · 2021-05-06T16:57:56Z

Per discussion, we need a document
on how render and fn will work when piped.

We need to prioritized this, filed an issue #1915, will start working on hashing these details out otherwise it will be hard to make progress on these PRs.

frankfarzan · 2021-05-06T17:45:54Z

To unblock this, we can address the piping behavior separeately. For now, this output lgtm:

$ kpt fn eval --image gcr.io/kpt-fn/set-namespace:v0.1 -- namespace=staging
[RUNNING] "gcr.io/kpt-fn/set-namespace:v0.1"
[PASS] "gcr.io/kpt-fn/set-namespace:v0.1"

thirdparty/kyaml/runfn/runfn.go

droot · 2021-05-06T21:28:48Z

internal/fnruntime/runner.go

-func newFnRunner(ctx context.Context, f *kptfilev1alpha2.Function, pkgPath types.UniquePath) (kio.Filter, error) {
+// NewContainerRunner returns a kio.Filter given a specification of a container function
+// and it's config.
+func NewContainerRunner(ctx context.Context, f *kptfilev1alpha2.Function, pkgPath types.UniquePath) (kio.Filter, error) {


Not happy with this name since the name represent lower level than FunctionRunner.

But unable to find a good name, not worth blocking the PR :)

thirdparty/kyaml/runfn/runfn.go

droot · 2021-05-06T21:48:22Z

thirdparty/kyaml/runfn/runfn.go

@@ -438,27 +443,30 @@ func (r *RunFns) defaultFnFilterProvider(spec runtimeutil.FunctionSpec, fnConfig
 				AllowMount: true,
 			},
 		}
-		cf := &runtimeutil.FunctionFilter{
+		fltr = &runtimeutil.FunctionFilter{


I would like to get away from crafting this filter here manually but it will be easier once my structured result changes are merged in.

* refactor fn runner * update eval output format * omit output when the result is printed to stdout * fix test * improve comment * always use FunctionRunner

Shell32-Natsu added this to the v1.0 m2 milestone May 5, 2021

Shell32-Natsu requested review from droot and frankfarzan May 5, 2021 19:46

droot mentioned this pull request May 6, 2021

kpt fn: refactored function runner #1918

Closed

Shell32-Natsu added 4 commits May 6, 2021 13:28

refactor fn runner

090047d

update eval output format

65745dc

omit output when the result is printed to stdout

e047686

fix test

b79c126

Shell32-Natsu force-pushed the eval-output branch from 9844d00 to b79c126 Compare May 6, 2021 20:57

Shell32-Natsu added 2 commits May 6, 2021 13:59

improve comment

6e77627

always use FunctionRunner

dbc3388

droot reviewed May 6, 2021

View reviewed changes

droot approved these changes May 6, 2021

View reviewed changes

Shell32-Natsu merged commit 255569b into kptdev:next May 6, 2021

Shell32-Natsu deleted the eval-output branch May 6, 2021 21:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Align eval output with render #1907

Align eval output with render #1907

Shell32-Natsu commented May 5, 2021 •

edited

Loading

frankfarzan commented May 5, 2021 •

edited by Shell32-Natsu

Loading

Shell32-Natsu commented May 5, 2021

frankfarzan commented May 5, 2021

Shell32-Natsu commented May 5, 2021

droot commented May 6, 2021

frankfarzan commented May 6, 2021 •

edited

Loading

droot May 6, 2021

droot May 6, 2021

Align eval output with render #1907

Align eval output with render #1907

Conversation

Shell32-Natsu commented May 5, 2021 • edited Loading

frankfarzan commented May 5, 2021 • edited by Shell32-Natsu Loading

Shell32-Natsu commented May 5, 2021

frankfarzan commented May 5, 2021

Shell32-Natsu commented May 5, 2021

droot commented May 6, 2021

frankfarzan commented May 6, 2021 • edited Loading

droot May 6, 2021

Choose a reason for hiding this comment

droot May 6, 2021

Choose a reason for hiding this comment

Shell32-Natsu commented May 5, 2021 •

edited

Loading

frankfarzan commented May 5, 2021 •

edited by Shell32-Natsu

Loading

frankfarzan commented May 6, 2021 •

edited

Loading