feat: Implement Canister Build Adapter Framework and Script Adapter

[rikonor]

Summary:

This PR introduces canister build adapters within the icp-adapter crate. It defines a common Adapter trait and provides an initial, fully functional implementation for a ScriptAdapter. This adapter allows canister builds to be performed by executing arbitrary shell commands. Placeholders for MotokoAdapter and RustAdapter are also included for future development.

Detailed Changes:

• Build Adapter Framework (lib/icp-adapter/src/lib.rs):

  • Introduced an async Adapter trait with a compile method, serving as the core abstraction for different build mechanisms.
  • Established modules for script, motoko, and rust adapters.
  • Implemented a unified AdapterCompileError enum using snafu for consistent error handling across adapters.

• Script Adapter (lib/icp-adapter/src/script.rs):

  • The ScriptAdapter allows defining canister build processes via one or more shell commands.
  • Commands are parsed using shellwords, enabling complex commands with quoted arguments.
  • The adapter executes commands within the canister's specified directory.
  • Standard input, output, and error streams are inherited from the executing process, making build logs directly visible.
  • Comprehensive error handling is in place for command parsing, invocation failures, and non-zero exit codes.
  • The ScriptAdapter configuration (e.g., the command(s) to run) is designed to be deserializable from a configuration file (like canister.yaml). For example:

    # canister.yaml (example snippet)
    build:
      adapter: script
      command: "npm run build"
    # or for multiple commands:
    # commands:
    #   - "npm install"
    #   - "npm run build"

• Placeholder Adapters:

  • Motoko Adapter (lib/icp-adapter/src/motoko.rs): Includes a basic MotokoAdapter struct and a stubbed compile method.
  • Rust Adapter (lib/icp-adapter/src/rust.rs): Includes a basic RustAdapter struct and a stubbed compile method.

Future Work:

• Implement the compilation logic for MotokoAdapter.
• Implement the compilation logic for RustAdapter.
• Integrate these adapters into the broader canister build lifecycle.

---

This PR description was generated by Roo.

[adamspofford-dfinity]

If this PR is meant to fully implement the adapter, it should contain the build cache directory logic, and a test for a script canister that invokes cargo build.

answer: no, it is not

[rikonor]

If this PR is meant to fully implement the adapter, it should contain the build cache directory logic, and a test for a script canister that invokes cargo build.

Hi @adamspofford-dfinity, as discussed in the team meeting, it doesn't seem like we've reached a consensus on how those things would work yet. I think it'd be valid to proceed with reviewing this code regardless since the things you've brought up would be additions to this code, rather than replace it. What is here works and is needed, so I don't see a need to wait for the design discussions to conclude.

[ghost]

Let's start with a test or tests, since it looks like this is at the point where it's possible to add them and verify some functionality.

[rikonor]

Let's start with a test or tests, since it looks like this is at the point where it's possible to add them and verify some functionality.

@ericswanson-dfinity Tests have been added.