shipit-cli 0.15.2__tar.gz → 0.16.0__tar.gz

{shipit_cli-0.15.2 → shipit_cli-0.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shipit-cli
-Version: 0.15.2
+Version: 0.16.0
 Summary: Shipit CLI is the best way to build, serve and deploy your projects anywhere.
 Project-URL: homepage, https://wasmer.io
 Project-URL: repository, https://github.com/wasmerio/shipit

{shipit_cli-0.15.2 → shipit_cli-0.16.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "shipit-cli"
-version = "0.15.2"
+version = "0.16.0"
 description = "Shipit CLI is the best way to build, serve and deploy your projects anywhere."
 readme = "README.md"
 requires-python = ">=3.10"

{shipit_cli-0.15.2 → shipit_cli-0.16.0}/src/shipit/assets/wordpress/wp-config.php

@@ -21,12 +21,55 @@ define( 'WP_AUTO_UPDATE_CORE', false); // Disable automatic aupdates and checks
  * @package WordPress
  */
 
+// Deserialize the value from the environment variable value
+function env_var_deserialize(string $value) {
+    $v = trim($value);
+    if ($v === '') {
+        return '';
+    }
+    $len = strlen($v);
+    if ($len >= 2 && ($v[0] === '"' || $v[0] === "'") && $v[0] === $v[$len - 1]) {
+        return substr($v, 1, -1);
+    }
+    $lower = strtolower($v);
+    static $scalarMap = [
+        'true'  => true,
+        'yes'   => true,
+        'on'    => true,
+        'y'     => true,
+        'false' => false,
+        'no'    => false,
+        'off'   => false,
+        'n'     => false,
+        'null'  => null,
+    ];
+    if (array_key_exists($lower, $scalarMap)) {
+        return $scalarMap[$lower];
+    }
+    if (ctype_digit($v) || ($v[0] === '-' && ctype_digit(substr($v, 1)))) {
+        return (int) $v;
+    }
+    if (is_numeric($v)) {
+        return (float) $v;
+    }
+    if (strpos($v, '://') !== false && filter_var($v, FILTER_VALIDATE_URL)) {
+        return $v;
+    }
+    if (strpos($v, ',') !== false) {
+        if (strncmp($v, 'http://', 7) === 0 || strncmp($v, 'https://', 8) === 0) {
+            return $v;
+        }
+        return array_map('trim', explode(',', $v));
+    }
+    return $v;
+}
 
-function get_env_var(string $name, string $default = ''): string
+
+function get_env_var(string $name, string $default = '')
 {
     $value = getenv($name);
     if ($value !== false) {
-        return $value;
+        return env_var_deserialize($value);
     }
 
     if ($default === '') {
@@ -36,11 +79,6 @@ function get_env_var(string $name, string $default = ''): string
     return $default;
 }
 
-function get_env_var_bool(string $name, bool $default = false): bool
-{
-    return in_array(get_env_var($name, $default ? "1" : "0"), ["1", "true", "yes", "on", "y"], true);
-}
-
 // ** Database settings - You can get this info from your web host ** //
 /** The name of the database for WordPress */
 define( 'DB_NAME', get_env_var('DB_NAME', 'wordpress') );
@@ -98,7 +136,7 @@ define( 'WP_SITEURL', get_env_var('WP_SITEURL', WP_HOME . '/') );
 
 define( 'WP_MEMORY_LIMIT', get_env_var('WP_MEMORY_LIMIT', '256M') );
 define( 'WP_MAX_MEMORY_LIMIT', get_env_var('WP_MAX_MEMORY_LIMIT', '256M') );
-define( 'WP_POST_REVISIONS', get_env_var_bool('WP_POST_REVISIONS', false));
+define( 'WP_POST_REVISIONS', get_env_var('WP_POST_REVISIONS', false));
 
 /**#@-*/
 
@@ -122,7 +160,7 @@ $table_prefix = 'wp_';
  *
  * @link https://wordpress.org/support/article/debugging-in-wordpress/
  */
-define( 'WP_DEBUG', get_env_var_bool('WP_DEBUG', false) );
+define( 'WP_DEBUG', get_env_var('WP_DEBUG', false) );
 
 /* Add any custom values between this line and the "stop editing" line. */
 
@@ -137,12 +175,32 @@ if ( getenv('WP_ADDITIONAL_CONFIG') ) {
     }
 }
 
-/* That's all, stop editing! Happy publishing. */
-
 /** Absolute path to the WordPress directory. */
 if ( ! defined( 'ABSPATH' ) ) {
     define( 'ABSPATH', __DIR__ . '/' );
 }
 
+function wpdefine_load_env_defines(string $prefix = 'WPDEFINE_'): void {
+    $env = $_ENV + $_SERVER;
+    $prefixLen = strlen($prefix);
+    foreach ($env as $key => $rawValue) {
+        if (!is_string($key) || strncmp($key, $prefix, $prefixLen) !== 0) {
+            continue;
+        }
+        $const = substr($key, $prefixLen);
+        if ($const === '' || defined($const)) {
+            continue;
+        }
+        if (!preg_match('/^[A-Z_][A-Z0-9_]*$/', $const)) {
+            continue;
+        }
+        define($const, env_var_deserialize((string) $rawValue));
+    }
+}
+
+wpdefine_load_env_defines();
+
+/* That's all, stop editing! Happy publishing. */
+
 /** Sets up WordPress vars and included files. */
 require_once ABSPATH . 'wp-settings.php';

{shipit_cli-0.15.2 → shipit_cli-0.16.0}/src/shipit/builders/docker.py

@@ -31,6 +31,9 @@ class DockerBuildBackend:
         "php": {
             "source": "ubi:adwinying/php",
         },
+        "go-wasix": {
+            "source": "ubi:wasix-org/go[extract_all=true,bin_path=bin/]",
+        },
         "composer": {
             "source": "ubi:composer/composer",
             "postinstall": """composer_dir=$(mise where ubi:composer/composer); ln -s "$composer_dir/composer.phar" /usr/local/bin/composer""",
@@ -38,7 +41,8 @@ class DockerBuildBackend:
     }
 
     def __init__(
-        self, src_dir: Path, assets_path: Path, docker_client: Optional[str] = None
+        self, src_dir: Path, assets_path: Path, docker_client: Optional[str] = None,
+        docker_opts: Optional[str] = None
     ) -> None:
         self.src_dir = src_dir
         self.assets_path = assets_path
@@ -50,6 +54,7 @@ class DockerBuildBackend:
         self.docker_ignore_path = self.docker_path / "Dockerfile.dockerignore"
         self.shipit_docker_path = Path("/shipit")
         self.docker_client = docker_client or "docker"
+        self.docker_opts = docker_opts
         self.env = {
             "HOME": "/root",
         }
@@ -76,6 +81,8 @@ class DockerBuildBackend:
         self.docker_name_path.write_text(image_name)
         self.print_dockerfile(contents)
         extra_args: List[str] = []
+        if self.docker_opts:
+            extra_args.append(self.docker_opts)
         sh.Command(self.docker_client)(
             "build",
             "-f",
@@ -217,10 +224,10 @@ RUN curl https://mise.run | sh
                     mapped_dependency = self.mise_mapper.get(dependency.name, {})
                     package_name = mapped_dependency.get("source", dependency.name)
                     if dependency.version:
-                        docker_file_contents += f"RUN mise use --global {package_name}@{dependency.version}\n"
+                        docker_file_contents += f"RUN mise use --global \"{package_name}@{dependency.version}\"\n"
                     else:
                         docker_file_contents += (
-                            f"RUN mise use --global {package_name}\n"
+                            f"RUN mise use --global \"{package_name}\"\n"
                         )
                     if mapped_dependency.get("postinstall"):
                         docker_file_contents += (

{shipit_cli-0.15.2 → shipit_cli-0.16.0}/src/shipit/cli.py

@@ -347,6 +347,10 @@ def auto(
         None,
         help="Use a specific Docker client (such as depot, podman, etc.)",
     ),
+    docker_opts: Optional[str] = typer.Option(
+        None,
+        help="Additional options to pass to the Docker client.",
+    ),
     skip_docker_if_safe_build: Optional[bool] = typer.Option(
         True,
         help="Skip Docker if the build can be done safely locally (only copy commands).",
@@ -464,6 +468,7 @@ def auto(
         wasmer=wasmer,
         docker=docker,
         docker_client=docker_client,
+        docker_opts=docker_opts,
         skip_docker_if_safe_build=skip_docker_if_safe_build,
         wasmer_registry=wasmer_registry,
         wasmer_token=wasmer_token,
@@ -610,6 +615,10 @@ def serve(
         None,
         help="Use a specific Docker client (such as depot, podman, etc.)",
     ),
+    docker_opts: Optional[str] = typer.Option(
+        None,
+        help="Additional options to pass to the Docker client.",
+    ),
     start: Optional[bool] = typer.Option(
         True,
         help="Run the start command after building.",
@@ -647,7 +656,7 @@ def serve(
 
     if docker or docker_client:
         build_backend: BuildBackend = DockerBuildBackend(
-            path, ASSETS_PATH, docker_client
+            path, ASSETS_PATH, docker_client, docker_opts
         )
     else:
         build_backend = LocalBuildBackend(path, ASSETS_PATH)
@@ -905,6 +914,10 @@ def build(
         None,
         help="Use a specific Docker client (such as depot, podman, etc.)",
     ),
+    docker_opts: Optional[str] = typer.Option(
+        None,
+        help="Additional options to pass to the Docker client.",
+    ),
     skip_docker_if_safe_build: Optional[bool] = typer.Option(
         True,
         help="Skip Docker if the build can be done safely locally (only copy commands).",
@@ -933,7 +946,7 @@ def build(
 
     if docker or docker_client:
         build_backend: BuildBackend = DockerBuildBackend(
-            path, ASSETS_PATH, docker_client
+            path, ASSETS_PATH, docker_client, docker_opts=docker_opts
         )
     else:
         build_backend = LocalBuildBackend(path, ASSETS_PATH)
@@ -995,6 +1008,7 @@ def build(
                 wasmer_token=wasmer_token,
                 docker=False,
                 docker_client=None,
+                docker_opts=None,
                 skip_docker_if_safe_build=False,
                 env_name=env_name,
                 serve_port=serve_port,
@@ -1015,8 +1029,11 @@ def build(
         "No start command could be found, please provide a start command"
     )
 
+    # Prepare the build steps (sometimes the runners need to adapt the dependencies)
+    build_steps = runner.prepare_build_steps(serve.build)
+
     # Build and serve
-    build_backend.build(serve.name, env, serve.mounts or [], serve.build)
+    build_backend.build(serve.name, env, serve.mounts or [], build_steps)
     runner.build(serve)
     if serve.prepare and not skip_prepare:
         runner.prepare(env, serve.prepare)

shipit_cli-0.16.0/src/shipit/providers/go.py

@@ -0,0 +1,110 @@
+from pathlib import Path
+from typing import Dict, Optional
+
+from .base import (
+    DetectResult,
+    DependencySpec,
+    Provider,
+    _exists,
+    ServiceSpec,
+    VolumeSpec,
+    MountSpec,
+    Config,
+)
+from .base import Config, Provider
+from pydantic_settings import SettingsConfigDict
+
+
+class GoConfig(Config):
+    model_config = SettingsConfigDict(extra="ignore", env_prefix="SHIPIT_")
+
+    go_version: Optional[str] = "1.25.5"
+    go_build_file: Optional[str] = None
+    serve_binary: Optional[str] = None
+
+
+class GoProvider(Provider):
+    def __init__(self, path: Path, config: GoConfig):
+        self.path = path
+        self.config = config
+
+    @classmethod
+    def load_config(cls, path: Path, base_config: Config) -> GoConfig:
+        config = GoConfig()
+        if not config.go_build_file:
+            build_file = cls.get_build_file(path)
+            config.go_build_file = build_file
+        if not config.go_build_file:
+            raise Exception("No build file for go found")
+        if not config.serve_binary:
+            config.serve_binary = config.go_build_file.replace("/", "_").lower().lstrip("_").replace(".go", "")
+        if not config.serve_binary:
+            raise Exception("No serve binary for go found")
+        return config
+
+    @classmethod
+    def name(cls) -> str:
+        return "go"
+
+    @classmethod
+    def get_build_file(cls, root_path: Path) -> str:
+        paths_to_try = ["main.go", "server.go", "serve.go", "api.go", "web.go"]
+        for path in paths_to_try:
+            if "*" in path:
+                continue  # This is for the glob finder
+            if _exists(root_path, path):
+                return path
+            if _exists(root_path, f"src/{path}"):
+                return f"src/{path}"
+        for path in paths_to_try:
+            found_path = next(root_path.glob(f"*/{path}"), None)
+            if not found_path:
+                found_path = next(root_path.glob(f"*/*/{path}"), None)
+            if found_path:
+                return str(found_path.relative_to(root_path))
+        return None
+
+    @classmethod
+    def detect(cls, path: Path, config: Config) -> Optional[DetectResult]:
+        if _exists(path, "go.mod", "go.sum"):
+            return DetectResult(cls.name(), 80)
+        return None
+
+    def serve_name(self) -> Optional[str]:
+        return None
+
+    def dependencies(self) -> list[DependencySpec]:
+        return [
+            DependencySpec(
+                "go",
+                var_name="config.go_version",
+                use_in_build=True,
+            ),
+        ]
+
+    def build_steps(self) -> list[str]:
+        return [
+            "workdir(temp.path)",
+            "use(go)",
+            'copy(".", ".", ignore=[".git"])',
+            'env(GOCACHE="/tmp/.cache/go-build", GOPATH=temp.path)',
+            'run("go build -o {} {}".format(config.serve_binary, config.go_build_file), group="build")',
+            'copy("{}/{}".format(temp.path, config.serve_binary), "{}/{}".format(app.path, config.serve_binary))',
+        ]
+
+    def mounts(self) -> list[MountSpec]:
+        return [
+            MountSpec("temp", attach_to_serve=False),
+            MountSpec("app", attach_to_serve=True),
+        ]
+
+    def commands(self) -> Dict[str, str]:
+        return {
+            "start": '"{}/{}".format(app.serve_path, config.serve_binary)',
+        }
+
+    def services(self) -> list[ServiceSpec]:
+        return []
+
+    def volumes(self) -> list[VolumeSpec]:
+        return []

{shipit_cli-0.15.2 → shipit_cli-0.16.0}/src/shipit/providers/registry.py

@@ -7,6 +7,7 @@ from .wordpress import WordPressProvider
 from .php import PhpProvider
 from .python import PythonProvider
 from .jekyll import JekyllProvider
+from .go import GoProvider
 from .staticfile import StaticFileProvider
 
 
@@ -21,5 +22,6 @@ def providers() -> list[type[Provider]]:
         PhpProvider,
         NodeStaticProvider,
         JekyllProvider,
+        GoProvider,
         StaticFileProvider,
     ]

{shipit_cli-0.15.2 → shipit_cli-0.16.0}/src/shipit/runners/base.py

@@ -4,13 +4,14 @@ from typing import Dict, List, Protocol, TYPE_CHECKING
 from shipit.builders.base import BuildBackend
 
 if TYPE_CHECKING:
-    from shipit.shipit_types import PrepareStep, Serve
+    from shipit.shipit_types import PrepareStep, Serve, Step
 
 
 class Runner(Protocol):
     build_backend: BuildBackend
 
     def prepare_config(self, provider_config: object) -> object: ...
+    def prepare_build_steps(self, build_steps: List["Step"]) -> List["Step"]: ...
     def build(self, serve: "Serve") -> None: ...
     def prepare(self, env: Dict[str, str], prepare: List["PrepareStep"]) -> None: ...
     def run_serve_command(self, command: str) -> None: ...

{shipit_cli-0.15.2 → shipit_cli-0.16.0}/src/shipit/runners/local.py

@@ -1,6 +1,6 @@
 import shutil
 from pathlib import Path
-from typing import Dict, List, Optional
+from typing import Dict, List, TYPE_CHECKING
 
 import sh  # type: ignore[import-untyped]
 from rich import box
@@ -12,6 +12,9 @@ from shipit.runners.base import Runner
 from shipit.shipit_types import PrepareStep, Serve
 from shipit.ui import console, write_stderr, write_stdout
 
+if TYPE_CHECKING:
+    from shipit.shipit_types import Step
+
 
 class LocalRunner:
     def __init__(self, build_backend: BuildBackend, src_dir: Path) -> None:
@@ -24,6 +27,9 @@ class LocalRunner:
     def prepare_config(self, provider_config: object) -> object:
         return provider_config
 
+    def prepare_build_steps(self, build_steps: List["Step"]) -> List["Step"]:
+        return build_steps
+
     def get_serve_mount_path(self, name: str) -> Path:
         return self.build_backend.get_artifact_mount_path(name)
 

{shipit_cli-0.15.2 → shipit_cli-0.16.0}/src/shipit/runners/wasmer.py

@@ -1,9 +1,11 @@
+from shipit.shipit_types import EnvStep
+from shipit.shipit_types import UseStep
 import hashlib
 import json
 import os
 import shlex
 from pathlib import Path
-from typing import Any, Dict, List, Optional, Set, TypedDict, cast
+from typing import Any, Dict, List, Optional, Set, TypedDict, TYPE_CHECKING
 
 import sh  # type: ignore[import-untyped]
 import yaml
@@ -14,10 +16,12 @@ from tomlkit import array, aot, comment, document, nl, string, table
 
 from shipit.builders.base import BuildBackend
 from shipit.runners.base import Runner
-from shipit.shipit_types import Package, PrepareStep, RunStep, Serve, WorkdirStep
+from shipit.shipit_types import Package, PrepareStep, Serve
 from shipit.ui import console, write_stderr, write_stdout
 from shipit.version import version as shipit_version
 
+if TYPE_CHECKING:
+    from shipit.shipit_types import Step
 
 class MapperItem(TypedDict, total=False):
     dependencies: Dict[str, str]
@@ -149,6 +153,30 @@ class WasmerRunner:
             provider_config.precompile_python = True
         return provider_config
 
+    def prepare_build_steps(self, build_steps: List["Step"]) -> List["Step"]:
+        new_build_steps: List["Step"] = []
+        for step in build_steps:
+            if isinstance(step, UseStep):
+                deps = []
+                found_go = False
+                for package in step.dependencies:
+                    if package.name == "go":
+                        deps.append(Package(name="go-wasix"))
+                        found_go = True
+                    else:
+                        deps.append(package)
+                if found_go:
+                    step = UseStep(dependencies=deps)
+                new_build_steps.append(step)
+                if found_go:
+                    new_build_steps.append(EnvStep(variables={
+                        "GOOS": "wasip1",
+                        "GOARCH": "wasm",
+                    }))
+            else:
+                new_build_steps.append(step)
+        return new_build_steps
+
     def build(self, serve: Serve) -> None:
         self.build_prepare(serve)
         self.build_serve(serve)
@@ -211,6 +239,17 @@ class WasmerRunner:
             ],
         )
 
+    def find_file_in_mounts(self, serve: Serve, program: str) -> Optional[Path]:
+        program_path = Path(program)
+        for mount in serve.mounts:
+            if program.startswith(str(mount.serve_path.absolute())):
+                module_path = program_path.relative_to(mount.serve_path).as_posix()
+                full_module_path = self.build_backend.get_artifact_mount_path(
+                    mount.name
+                ) / module_path
+                return full_module_path
+        return None
+
     def build_serve(self, serve: Serve) -> None:
         doc = document()
         doc.add(comment(f"Wasmer manifest generated with Shipit v{shipit_version}"))
@@ -278,7 +317,8 @@ class WasmerRunner:
                     ),
                 )
 
-        doc.add(nl())
+        modules = None
+
         if serve.commands:
             commands = aot()
             doc.add("command", commands)
@@ -287,27 +327,54 @@ class WasmerRunner:
                 commands.append(command)
                 parts = shlex.split(command_line)
                 program = parts[0]
+                command_env = {}
+                command_module = None
                 if program in self.rewrite_binaries:
                     rewritten_program = shlex.split(self.rewrite_binaries[program])
                     program = rewritten_program[0]
                     parts[:1] = rewritten_program
                 elif program not in binaries:
-                    raise Exception(f"Binary {program} not runable in Wasmer yet")
+                    if program.startswith("/"):
+                        # It's an executable
+                        full_module_path = self.find_file_in_mounts(serve, program)
+                        if not full_module_path:
+                            raise Exception(f"Could not find {program} in the mounts or in the binaries list")
+                        # Check if is a WebAssembly module by checking the contents
+                        if not full_module_path.read_bytes().startswith(b"\0asm"):
+                            raise Exception(f"Wasmer can only execute WebAssembly modules, binary {program} is not.")
+                        
+                        if not modules:
+                            modules = aot()
+                            doc.add("module", modules)
+                        
+                        module = table()
+                        modules.append(module)
+                        module_name = program.replace("/", "_").lower().lstrip("_")
+                        module.add("name", module_name)
+                        module.add("source", str(full_module_path.absolute()))
+
+                        command_module = module_name
+                    else:
+                        raise Exception(f"Binary {program} not runable in Wasmer yet")
+                
+                if not command_module:
+                    program_binary = binaries.get(program)
+                    if not program_binary:
+                        raise Exception(f"Command {command_name} is trying to run {program} but it is not available (dependencies: {', '.join(dependencies.keys())}, programs: {', '.join(binaries.keys())})")
+                    command_module = program_binary["script"]
+                    command_env.update(program_binary.get("env") or {})
+
                 command.add("name", command_name)
-                program_binary = binaries.get(program)
-                if not program_binary:
-                    raise Exception(f"Command {command_name} is trying to run {program} but it is not available (dependencies: {', '.join(dependencies.keys())}, programs: {', '.join(binaries.keys())})")
-                command.add("module", program_binary["script"])
+                command.add("module", command_module)
                 command.add("runner", "wasi")
                 wasi_args = table()
                 if serve.cwd:
                     wasi_args.add("cwd", serve.cwd)
                 wasi_args.add("main-args", array(parts[1:]).multiline(True))
-                env = program_binary.get("env") or {}
                 if serve.env:
-                    env.update(serve.env)
-                if env:
-                    arr = array([f"{k}={v}" for k, v in env.items()]).multiline(True)
+                    command_env.update(serve.env)
+                if command_env:
+                    arr = array([f"{k}={v}" for k, v in command_env.items()]).multiline(True)
                     wasi_args.add("env", arr)
                 title = string("annotations.wasi", literal=False)
                 command.add(title, wasi_args)

shipit_cli-0.16.0/src/shipit/version.py

@@ -0,0 +1,5 @@
+__all__ = ["version", "version_info"]
+
+
+version = "0.16.0"
+version_info = (0, 16, 0, "final", 0)

shipit_cli-0.15.2/src/shipit/version.py

@@ -1,5 +0,0 @@
-__all__ = ["version", "version_info"]
-
-
-version = "0.15.2"
-version_info = (0, 15, 2, "final", 0)