feat: run plugins — WebAssembly, digest-pinned, installed with godo -e plugins

.goreleaser.yaml

@@ -28,6 +28,13 @@ builds:
 
 archives:
   - id: archive
+    # Default files are LICENSE*/README*/CHANGELOG*. The binaries statically
+    # link Apache-2.0 code (wazero), whose attribution has to ship with them.
+    files:
+      - LICENSE
+      - THIRD_PARTY_LICENSES.md
+      - README.md
+      - CHANGELOG.md
     formats: [tar.gz]
     format_overrides:
       - goos: windows

CHANGELOG.md

@@ -45,6 +45,20 @@ Breaking. The shell that runs your scripts changed.
   they are parsed and validated so the shape is settled, and a script asking
   for a runner a plugin provides fails by naming that plugin instead of reading
   as a typo.
+- **`${godo:file(path)}` as a whole script value** puts the body in a file, so
+  a Python or shell script gets an editor that understands it. Inclusion rather
+  than expansion: it happens when the body is read, works for every runner, and
+  leaves `${godo:…}` inside the file alone.
+- **A `fetch` op**: plugins can make HTTP requests through godo, which does
+  them with Go's client — the same on every platform godo ships to. Without it
+  the only route to the network is exec'ing `curl`, which is the platform
+  dependency a plugin exists to remove. Bodies travel base64 because they are
+  bytes, and requests time out after 30 seconds.
+- **`godo -e plugins install <source>`** fetches an artifact, computes its
+  digest, stores it under `<user cache>/godo/plugins`, and writes the entry into
+  `godo.yaml` — preserving the comments, blank lines and block scalars around
+  it. Without a source it fetches everything the catalog declares.
+  `godo -e plugins` lists what is declared and whether it is here.
 - **`godo -e runners`** lists what is usable on the machine you are on, and how
   to confirm which shell you are in when the detected one looks wrong.
 - `--ls <tokens>` prints `@runner` beside `@dialect`.

THIRD_PARTY_LICENSES.md

@@ -0,0 +1,251 @@
+# Third-party licenses
+
+GoDo is MIT (see [LICENSE](./LICENSE)). The binaries shipped on GitHub Releases
+statically link the libraries below, so their notices travel with them.
+
+Source dependencies are listed in [go.mod](./go.mod).
+
+Every licence here is permissive. None of them asks GoDo to change its own, and
+none of them reaches into a plugin: a plugin is a separate artifact from a
+separate repository, and GoDo does not ship one. What a plugin contains is
+that repository's inventory to publish, next to its own artifact.
+
+---
+
+## github.com/tetratelabs/wazero
+
+WebAssembly runtime. Used to run plugins.
+
+Licensed under the Apache License, Version 2.0.
+
+### NOTICE
+
+```
+wazero
+Copyright 2020-2023 wazero authors
+```
+
+### License
+
+```
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020-2023 wazero authors
+
+   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.
+```
+
+---
+
+## golang.org/x/sys
+
+Low-level OS primitives. Pulled in by wazero.
+
+Licensed under the BSD 3-Clause License, `Copyright (c) 2009 The Go Authors`.
+Same terms as the Go standard library, whose runtime is already part of every
+Go binary.
+
+---
+
+## gopkg.in/yaml.v3
+
+YAML parser. Used to read `godo.yaml`.
+
+Licensed under the MIT License, with portions under the Apache License,
+Version 2.0. See the module's `LICENSE` and `NOTICE` files.

docs/contract.md

@@ -101,15 +101,31 @@ numbers.
 
 ### `engine.plugins`
 
-**No build loads plugins yet.** Entries are parsed and validated so the shape
-is settled and a catalog can already declare what it expects.
+```
+godo -e plugins                    what this catalog declares, and its state
+godo -e plugins install            fetch everything it declares
+godo -e plugins install <source>   add one, and fetch it
+```
+
+`install <source>` computes the digest from the artifact and writes the entry
+into `godo.yaml`. The digest is never asked for: a person cannot check a hash
+by reading it, so asking for one is how wrong hashes get committed.
+
+Artifacts live in `<user cache>/godo/plugins`, named by digest. A file sitting
+beside the `godo.yaml` is loaded from where it is — asking someone to install
+what they can already see would be ceremony, and its digest is checked either
+way. Anything else must be installed first; a run is not the moment to discover
+that something has to be downloaded.
+
+`http://` sources are refused. An artifact is code, and its integrity cannot
+rest on a transport anyone on the path can rewrite.
 
 | Field | |
 |-------|--|
-| `source` | Required. Where the plugin comes from |
+| `source` | Required. An `https://` URL, or a path relative to the `godo.yaml` |
 | `sha256` | **Required.** A plugin is third-party code that runs when someone types `godo test`; without a digest there is nothing to verify it is the code that was reviewed |
 | `provides` | Required. `"<kind>:<name>"` entries, kind being `runner` or `dialect`. Two plugins may not provide the same one |
-| `config` | Optional, and entirely the plugin's: its keys, its meaning, its defaults. godo carries it across without reading it |
+| `config` | Optional, and the plugin's: its keys, its meaning, its defaults. godo carries it across and reads only `fs.mount`, which says which directories the sandbox can see |
 
 A script asking for a runner a plugin provides fails by naming that plugin:
 
@@ -275,6 +291,41 @@ text is trusted — it is repo code. Values substituted into it are quoted, so
 arguments and captures are data, not shell syntax; `${godo:…:raw}` waives that for one
 placeholder and puts the trust decision back on the catalog author.
 
+## Bodies in a file
+
+A script's value may be a single `${godo:file(path)}`, and the body is then the
+contents of that file:
+
+```yaml
+scripts:
+  # @runner micropy
+  worktree create ${BRANCH} ${DIR}: ${godo:file(./worktree.godo.py)}
+```
+
+It uses the `${godo:…}` namespace because that namespace already exists and is
+already godo's alone — there is nothing for it to collide with.
+
+It is **inclusion, not expansion**, and the two happen at different times:
+
+| | when | what |
+|--|------|------|
+| `${godo:file(…)}` | reading the catalog | the body becomes the file's contents |
+| `${godo:args…}`, `${godo:argv[…]}` | building the plan | values are substituted, for runners that take a rendered line |
+
+Because inclusion happens first, it works for every runner — including one
+whose bodies are never expanded at all.
+
+After that, an included body behaves **exactly as if it had been pasted into
+the YAML**. There is no second rule: under `shell` its `${godo:args…}` expand
+like any other body's, and under a plugin runner they stay literal, because
+that runner's bodies are not expanded either way.
+
+- The path is relative to the `godo.yaml`, not to the caller's directory: a
+  script says where its body lives, and that does not move.
+- It must be the **whole value**. Splicing a file into part of a line would
+  paste newlines into a command; `echo ${godo:file(m.txt)}` is an error.
+- A `string[]` may mix included and inline entries.
+
 ## Script decorators (JSDoc style)
 
 YAML comment block **immediately above** the script key. Apply to scripts only.

docs/dev/README.md

@@ -8,6 +8,7 @@ Internals and contributor conventions. Product docs live in [`docs/`](../README.
 | [Standards](./standards.md) | Coding bar |
 | [Versioning](./versioning.md) | SemVer + binary vs file `version:` |
 | [Runners and plugins](./runners-and-plugins.md) | Premise: godo is a proxy; cross-OS is a plugin's job |
+| [Plugin protocol](./plugin-protocol.md) | The wire: WASI command, JSON ops, capabilities |
 | [Archive](./archive/README.md) | Brainstorm notes (historical) |
 
 Start with root [`CONTRIBUTING.md`](../../CONTRIBUTING.md).