Add a script to help managing embedded scripts externally #740

chmouel · 2021-05-26T12:54:54Z

The idea of this script is if you have inside your script something like this :

It will replace this #include with the content of python/script.py

This make it easier to write your tasks and use linters/code checkers from your
editor on your included script.

This sparked from @afrittoli discussion here #715

Currently this is a helper so this would be up to the contributor to uses it before commit but i think we can maybe think on how to do this post merge so to be transparent.

tekton-robot · 2021-05-26T12:54:57Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign chmouel
You can assign the PR to them by writing /assign @chmouel in a comment when ready.

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

Needs approval from an approver in each of these files:

OWNERS

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

afrittoli

Thank you for starting this!

I think it's fine to have it under a test folder at least for now - eventually we might want some way to make it easier for contributors to include this in their workflow... perhaps a make target or a shell script.

Eventually we'll need

unit tests for this python
a script to trigger this and write the output in the right place
a CI job to run the script and check that generated YAMLs are up to date

But not in this PR :)

/lgtm

afrittoli · 2021-05-26T13:06:18Z

test/embedded-script-external/README.md

+      script: "#include script.sh"
+```
+
+The script will see it and includes the `script.sh` in place of your "#include script.sh"


It would be nice to document that the result is sent to stdout and that if more than one YAML docs is in the source, all be parsed and separated by ---.

Yep 👍🏻

afrittoli · 2021-05-26T13:06:37Z

test/embedded-script-external/embedded-script-external.py

+REGEXP = r"^#include\s*([^$]*)"
+
+
+def replace(filename: str) -> typing.List:


Eventually we should have unit tests 🙏

Yep I added some, i didn't bother because we don't have ways to run them yet 😅

I usually use pytest but i guess python builtin unittest should be enough for this so we can just python3 the test file directly and it will run them.

The idea of this script is if you have inside your script something like this : It will replace this #include with the content of python/script.py This make it easier to write your tasks and use linters/code checkers from your editor on your included script.

chmouel · 2021-05-26T14:18:45Z

a script to trigger this and write the output in the right place

how would that work tho?

In main we have the "#include script.py" template files? But users (including ides/tkn hub or even curl people) would expect to be able to run the task directly from main branch, isnt it ?

maybe we can have both, we could have a comment above the script: which would tell how to replace the script field to the CI jobs at post merge time, it would not matter the script content because the source of truth would be the #include script content.

Maybe that's a bit confusing, so let me rephrase my thinking :

Dev have task/foo/0.1/task.yaml
task.yaml has something like this :

steps:
   - name: foo
     #include foo.py
     script : | 
       #!/usr/bin/env python
       print("helo world")

dev do some changes inside the foo.py and submit as PR,
test-runner sees the #include and automatically test it with the new content from foo.py in script
We merge the PR
A post merge job would replace the script portion with the content from foo.py and commit back to catalog.

This allows user to have the latest task working directly and devs being able to develop into a real file for the script portion.

Let me know if that make sense 🙇🏻

afrittoli · 2021-07-23T13:40:22Z

a script to trigger this and write the output in the right place

how would that work tho?

In main we have the "#include script.py" template files? But users (including ides/tkn hub or even curl people) would expect to be able to run the task directly from main branch, isnt it ?

maybe we can have both, we could have a comment above the script: which would tell how to replace the script field to the CI jobs at post merge time, it would not matter the script content because the source of truth would be the #include script content.

Maybe that's a bit confusing, so let me rephrase my thinking :

Dev have task/foo/0.1/task.yaml

task.yaml has something like this :
steps:
   - name: foo
     #include foo.py
     script : | 
       #!/usr/bin/env python
       print("helo world")
dev do some changes inside the foo.py and submit as PR,

test-runner sees the #include and automatically test it with the new content from foo.py in script

We merge the PR

A post merge job would replace the script portion with the content from foo.py and commit back to catalog.

I don't like this approach too much because it means that we need two commits to do a change, and in between commits the repo is in an inconsistent state.

This allows user to have the latest task working directly and devs being able to develop into a real file for the script portion.

Let me know if that make sense 🙇🏻

The workflow I had in mind is very much similar to what we have to generated golang files in pipeline and other repos.

Dev creates / updates the task in task/foo/0.1/task.yaml.template
task.yaml.template has something like this :

steps:
   - name: foo
     #include foo.py
     script : | 
       #!/usr/bin/env python
       print("helo world")

Dev creates / updates the script in task/foo/0.1/foo.py
Before committing, dev runs tools/embed-scripts.sh, which generates task/foo/0.1/task.yaml
CI runs tools/embed-scripts.sh and diffs. If differences are found it fails. Differences could happen if:
- if the dev updated the script and did not run the embed tool
- if the dev made changes into the generated task.yaml instead of the template / script
task/foo/0.1/task.yaml alone is published to the bundle
users only ever refer to task/foo/0.1/task.yaml

The paths / naming might change, we could have the template defined in a subfolder for instance, to "hide" it from users.

afrittoli

I think this is a great start, thank you!
We'll need to create an infra image that embeds the script, so we can use it to run a CI job.
For that we'll need a docker file and a requirements.txt, but we can add those in a follow up.
/lgtm

afrittoli · 2021-10-15T08:54:16Z

@tektoncd/catalog-maintainers it would be nice to move forward on this - can we have a second reviewer?

vinamra28 · 2021-10-15T09:50:21Z

test/embed-script-externally/README.md

+spec:
+  steps:
+    - name: step1
+      script: "#include script.sh"


how about keeping it like ⬇️ ?

Suggested change

script: "#include script.sh"

script: "#include /path/to/script.sh"

vinamra28 · 2021-10-15T09:51:02Z

test/embed-script-externally/README.md

+      script: "#include script.sh"
+```
+
+The "embed_script" script will see it and includes the `script.sh` in place of


Suggested change

The "embed_script" script will see it and includes the `script.sh` in place of

The "embed_script" script will see it in the specified path and includes the `script.sh` in place of

vinamra28 · 2021-10-15T09:53:06Z

test/embed-script-externally/__init__.py

+# Author: Chmouel Boudjnah <[email protected]>
+#
+# 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.


should we change this as well to Tekton Authors?

tekton-robot · 2022-01-13T10:19:28Z

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale with a justification.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/lifecycle stale

Send feedback to tektoncd/plumbing.

chmouel · 2022-01-13T12:01:54Z

/remove-lifecycle stale

i didnt see your review @vinamra28 🙇🏻

tekton-robot · 2022-04-13T12:45:47Z

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale with a justification.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/lifecycle stale

Send feedback to tektoncd/plumbing.

tekton-robot · 2022-05-13T12:57:47Z

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten with a justification.
Rotten issues close after an additional 30d of inactivity.
If this issue is safe to close now please do so with /close with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/lifecycle rotten

Send feedback to tektoncd/plumbing.

tekton-robot · 2022-06-12T13:52:02Z

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen with a justification.
Mark the issue as fresh with /remove-lifecycle rotten with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/close

Send feedback to tektoncd/plumbing.

tekton-robot · 2022-06-12T13:52:05Z

@tekton-robot: Closed this PR.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen with a justification.
Mark the issue as fresh with /remove-lifecycle rotten with a justification.
If this issue should be exempted, mark the issue as frozen with /lifecycle frozen with a justification.

/close

Send feedback to tektoncd/plumbing.

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.

vinamra28 · 2022-06-13T06:59:05Z

/remove-lifecycle rotten
/lifecycle frozen
/reopen
@chmouel any updates on this?

tekton-robot · 2022-06-13T06:59:06Z

@vinamra28: Reopened this PR.

In response to this:

/remove-lifecycle rotten
/lifecycle frozen
/reopen
@chmouel any updates on this?

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.

tekton-robot · 2022-06-13T07:30:59Z

@chmouel: The following test failed, say /retest to rerun them all:

Test name	Commit	Details	Rerun command
pull-tekton-catalog-integration-tests	`3d32e30`	link	`/test pull-tekton-catalog-integration-tests`

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.

chmouel · 2022-06-13T08:02:23Z

I don't think it's trivial to do this, this will broke the "kuebctl apply -f https://github.com/tektoncd/catalog/path/to/task.yaml" maybe with this TEP which split the structure from the implementation we may be able to achive that but this probably need something extras on the hub end...

afrittoli · 2022-06-13T10:00:32Z

I don't think it's trivial to do this, this will broke the "kuebctl apply -f https://github.com/tektoncd/catalog/path/to/task.yaml"

Not necessarily, it depends on how it's implemented. My suggestion would be:

store in the catalog the template (YAML without the scripts), the script and the rendered version
the rendered version would be stored in the same location as today
add a CI job that renders the final task (template + script) and checks that it matches the rendered version in the repo
provide catalog authors with a script to run to update all rendered tasks

maybe with this TEP which split the structure from the implementation we may be able to achive that but this probably need something extras on the hub end...

chmouel · 2022-06-13T11:17:54Z

Not necessarily, it depends on how it's implemented. My suggestion would be:

store in the catalog the template (YAML without the scripts), the script and the rendered version
the rendered version would be stored in the same location as today
add a CI job that renders the final task (template + script) and checks that it matches the rendered version in the repo

I think it may be a bit cumbersome for non frequent contributor, we have generation on cli for mans/golden etc.. and it's already a source of annoyances since it's easy to forget to run the command before sending the iteration.

What about CI job commiting to the repo the final rendered version directly to a branch?

alternatively if hub could do this transparently and we say that hub is the "only" trusted source, then we would not have to store the yaml in repo.

provide catalog authors with a script to run to update all rendered tasks

tekton-robot requested review from kimsterv and a user May 26, 2021 12:54

tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 26, 2021

afrittoli reviewed May 26, 2021

View reviewed changes

tekton-robot assigned afrittoli May 26, 2021

tekton-robot added the lgtm Indicates that a PR is ready to be merged. label May 26, 2021

chmouel force-pushed the add-embed-script branch from 9ae22bf to 3d32e30 Compare May 26, 2021 14:07

tekton-robot removed the lgtm Indicates that a PR is ready to be merged. label May 26, 2021

afrittoli mentioned this pull request Jul 23, 2021

Recommend versioning script instead of using configmap 📝 #791

Merged

1 task

afrittoli reviewed Jul 23, 2021

View reviewed changes

tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 23, 2021

vinamra28 reviewed Oct 15, 2021

View reviewed changes

tekton-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 13, 2022

tekton-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 13, 2022

tekton-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 13, 2022

tekton-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels May 13, 2022

tekton-robot closed this Jun 12, 2022

tekton-robot reopened this Jun 13, 2022

tekton-robot added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. and removed lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. labels Jun 13, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a script to help managing embedded scripts externally #740

Add a script to help managing embedded scripts externally #740

chmouel commented May 26, 2021

tekton-robot commented May 26, 2021

afrittoli left a comment

afrittoli May 26, 2021

chmouel May 26, 2021

afrittoli May 26, 2021

chmouel May 26, 2021 •

edited

Loading

chmouel commented May 26, 2021

afrittoli commented Jul 23, 2021

afrittoli left a comment

afrittoli commented Oct 15, 2021

vinamra28 Oct 15, 2021

vinamra28 Oct 15, 2021

vinamra28 Oct 15, 2021

tekton-robot commented Jan 13, 2022

chmouel commented Jan 13, 2022

tekton-robot commented Apr 13, 2022

tekton-robot commented May 13, 2022

tekton-robot commented Jun 12, 2022

tekton-robot commented Jun 12, 2022

vinamra28 commented Jun 13, 2022

tekton-robot commented Jun 13, 2022

tekton-robot commented Jun 13, 2022

chmouel commented Jun 13, 2022

afrittoli commented Jun 13, 2022

chmouel commented Jun 13, 2022

		REGEXP = r"^#include\s([^$])"


		def replace(filename: str) -> typing.List:

	script: "#include script.sh"
	script: "#include /path/to/script.sh"

	The "embed_script" script will see it and includes the `script.sh` in place of
	The "embed_script" script will see it in the specified path and includes the `script.sh` in place of

Add a script to help managing embedded scripts externally #740

Are you sure you want to change the base?

Add a script to help managing embedded scripts externally #740

Conversation

chmouel commented May 26, 2021

tekton-robot commented May 26, 2021

afrittoli left a comment

Choose a reason for hiding this comment

afrittoli May 26, 2021

Choose a reason for hiding this comment

chmouel May 26, 2021

Choose a reason for hiding this comment

afrittoli May 26, 2021

Choose a reason for hiding this comment

chmouel May 26, 2021 • edited Loading

Choose a reason for hiding this comment

chmouel commented May 26, 2021

afrittoli commented Jul 23, 2021

afrittoli left a comment

Choose a reason for hiding this comment

afrittoli commented Oct 15, 2021

vinamra28 Oct 15, 2021

Choose a reason for hiding this comment

vinamra28 Oct 15, 2021

Choose a reason for hiding this comment

vinamra28 Oct 15, 2021

Choose a reason for hiding this comment

tekton-robot commented Jan 13, 2022

chmouel commented Jan 13, 2022

tekton-robot commented Apr 13, 2022

tekton-robot commented May 13, 2022

tekton-robot commented Jun 12, 2022

tekton-robot commented Jun 12, 2022

vinamra28 commented Jun 13, 2022

tekton-robot commented Jun 13, 2022

tekton-robot commented Jun 13, 2022

chmouel commented Jun 13, 2022

afrittoli commented Jun 13, 2022

chmouel commented Jun 13, 2022

chmouel May 26, 2021 •

edited

Loading