@aws/nx-plugin 1.1.1 → 1.3.0

package/src/greengrass/component/python/__snapshots__/generator.spec.ts.snap

@@ -0,0 +1,450 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`greengrass#component generator (python) > multi-architecture (platform: linux-amd64-arm64) > should match snapshot for a multi-architecture component > multi-arch-snapshot 1`] = `
+{
+  "apps/test_project/greengrass/my-component/main.py": "import logging
+import time
+
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger("com.proj.MyComponent")
+
+RUN_INTERVAL_SECONDS = 30
+
+
+def run_once(sequence: int) -> None:
+    logger.info("com.proj.MyComponent heartbeat %s", sequence)
+
+
+def main() -> None:
+    sequence = 0
+    while True:
+        run_once(sequence)
+        sequence += 1
+        time.sleep(RUN_INTERVAL_SECONDS)
+
+
+if __name__ == "__main__":
+    main()
+",
+  "apps/test_project/greengrass/my-component/recipe.yaml": "RecipeFormatVersion: '2020-01-25'
+ComponentName: com.proj.MyComponent
+ComponentVersion: 1.0.0
+ComponentDescription: com.proj.MyComponent Greengrass component using Python 3.14, generated by greengrass#component.
+ComponentPublisher: proj
+Manifests:
+  - Platform:
+      os: linux
+      architecture: amd64
+    Artifacts:
+      # Placeholders are substituted at publish time. The basename must stay
+      # my-component-amd64.zip, which is what the Run script below unarchives to.
+      - Uri: s3://BUCKET_NAME/COMPONENT_NAME/COMPONENT_VERSION/my-component-amd64.zip
+        Unarchive: ZIP
+    Lifecycle:
+      Run: python3.14 {artifacts:decompressedPath}/my-component-amd64/main.py
+  - Platform:
+      os: linux
+      architecture: aarch64
+    Artifacts:
+      # Placeholders are substituted at publish time. The basename must stay
+      # my-component-aarch64.zip, which is what the Run script below unarchives to.
+      - Uri: s3://BUCKET_NAME/COMPONENT_NAME/COMPONENT_VERSION/my-component-aarch64.zip
+        Unarchive: ZIP
+    Lifecycle:
+      Run: python3.14 {artifacts:decompressedPath}/my-component-aarch64/main.py
+",
+  "apps/test_project/project.json": "{
+  "name": "test-project",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "apps/test_project/test_project",
+  "metadata": {
+    "components": [
+      {
+        "generator": "greengrass#component",
+        "path": "greengrass/my-component/main.py",
+        "name": "my-component",
+        "language": "python",
+        "componentName": "com.proj.MyComponent",
+        "componentVersion": "1.0.0",
+        "platform": "linux-amd64-arm64",
+        "ipc": false,
+        "gdkConfig": false
+      }
+    ]
+  },
+  "targets": {
+    "assemble": {
+      "dependsOn": ["my-component-artifact"]
+    },
+    "build": {
+      "dependsOn": ["my-component-artifact"]
+    },
+    "my-component-artifact": {
+      "executor": "nx:run-commands",
+      "dependsOn": ["my-component-vendor"],
+      "cache": true,
+      "inputs": [
+        "production",
+        "^production",
+        "{workspaceRoot}/packages/common/scripts/src/greengrass/**/*"
+      ],
+      "outputs": [
+        "{workspaceRoot}/dist/{projectRoot}/greengrass/my-component/greengrass-build"
+      ],
+      "options": {
+        "command": "tsx packages/common/scripts/src/greengrass/build-artifact.ts {projectRoot} my-component dist/{projectRoot}/greengrass/my-component --platforms=amd64,aarch64"
+      }
+    },
+    "my-component-deploy-local": {
+      "executor": "nx:run-commands",
+      "dependsOn": ["my-component-artifact"],
+      "options": {
+        "command": "tsx packages/common/scripts/src/greengrass/deploy-local.ts dist/{projectRoot}/greengrass/my-component"
+      }
+    },
+    "my-component-logs": {
+      "executor": "nx:run-commands",
+      "continuous": true,
+      "options": {
+        "command": "tsx packages/common/scripts/src/greengrass/component-logs.ts com.proj.MyComponent"
+      }
+    },
+    "my-component-vendor": {
+      "executor": "nx:run-commands",
+      "dependsOn": ["compile"],
+      "cache": true,
+      "inputs": ["production", "^production"],
+      "outputs": [
+        "{workspaceRoot}/dist/{projectRoot}/greengrass/my-component/vendor"
+      ],
+      "options": {
+        "commands": [
+          "shx rm -rf dist/{projectRoot}/greengrass/my-component/vendor",
+          "shx mkdir -p dist/{projectRoot}/greengrass/my-component/vendor",
+          "uv export --frozen --no-dev --no-editable --no-emit-project --project {projectRoot} --package test-project -o dist/{projectRoot}/greengrass/my-component/vendor/requirements.txt",
+          "uv pip install -n --no-deps --no-installer-metadata --no-compile-bytecode --only-binary :all: --python-platform x86_64-manylinux_2_28 --python-version 3.14 --target dist/{projectRoot}/greengrass/my-component/vendor/amd64 -r dist/{projectRoot}/greengrass/my-component/vendor/requirements.txt",
+          "uv pip install -n --no-deps --no-installer-metadata --no-compile-bytecode --only-binary :all: --python-platform aarch64-manylinux_2_28 --python-version 3.14 --target dist/{projectRoot}/greengrass/my-component/vendor/aarch64 -r dist/{projectRoot}/greengrass/my-component/vendor/requirements.txt"
+        ],
+        "parallel": false
+      }
+    }
+  }
+}
+",
+  "apps/test_project/tests/greengrass/test_my_component.py": "import importlib.util
+from pathlib import Path
+
+# main.py lives beside recipe.yaml under greengrass/<component>/, outside this
+# project's importable package, so it is loaded directly by file path.
+PROJECT_ROOT = Path(__file__).resolve().parents[2]
+MAIN_PATH = PROJECT_ROOT / "greengrass" / "my-component" / "main.py"
+
+
+def _load_main():
+    spec = importlib.util.spec_from_file_location("my_component_main", MAIN_PATH)
+    assert spec is not None and spec.loader is not None
+    module = importlib.util.module_from_spec(spec)
+    spec.loader.exec_module(module)
+    return module
+
+
+def test_run_once_does_not_raise():
+    module = _load_main()
+    module.run_once(1)
+",
+  "packages/common/scripts/project.json": "{
+  "name": "@proj/common-scripts",
+  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "packages/common/scripts/src",
+  "projectType": "library",
+  "tags": [],
+  "metadata": {
+    "generator": "ts#project"
+  },
+  "targets": {
+    "assemble": {
+      "dependsOn": ["compile"]
+    },
+    "build": {
+      "dependsOn": ["lint", "compile", "test"]
+    },
+    "compile": {
+      "executor": "nx:run-commands",
+      "outputs": ["{workspaceRoot}/dist/{projectRoot}/tsc"],
+      "options": {
+        "command": "tsc --build tsconfig.lib.json",
+        "cwd": "{projectRoot}"
+      }
+    },
+    "format": {
+      "executor": "nx:run-commands",
+      "cache": true,
+      "inputs": ["biome"],
+      "options": {
+        "command": "biome format {projectRoot}"
+      },
+      "configurations": {
+        "fix": {
+          "command": "biome format --write {projectRoot}"
+        },
+        "skip-lint": {
+          "command": "node -e \\"\\""
+        }
+      }
+    },
+    "lint": {
+      "executor": "nx:run-commands",
+      "cache": true,
+      "inputs": ["biome"],
+      "dependsOn": ["format"],
+      "options": {
+        "command": "biome lint {projectRoot}"
+      },
+      "configurations": {
+        "fix": {
+          "command": "biome check --write {projectRoot}"
+        },
+        "skip-lint": {
+          "command": "node -e \\"\\""
+        }
+      }
+    }
+  }
+}
+",
+  "pnpm-workspace.yaml": "packages:
+  - packages/*
+  - packages/common/*
+catalog:
+  '@types/node': 26.6.5
+  vite: 8.3.4
+  vitest: 5.0.4
+  '@vitest/coverage-v8': 5.0.4
+  jsdom: 29.1.1
+  '@nx/vitest': 23.3.0
+  js-yaml: 4.3.2
+  '@types/js-yaml': 4.0.9
+  tsx: 4.23.15
+  shx: 0.4.0
+",
+}
+`;
+
+exports[`greengrass#component generator (python) > should match snapshot > main-snapshot 1`] = `
+{
+  "apps/test_project/greengrass/my-component/main.py": "import logging
+import time
+
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger("com.proj.MyComponent")
+
+RUN_INTERVAL_SECONDS = 30
+
+
+def run_once(sequence: int) -> None:
+    logger.info("com.proj.MyComponent heartbeat %s", sequence)
+
+
+def main() -> None:
+    sequence = 0
+    while True:
+        run_once(sequence)
+        sequence += 1
+        time.sleep(RUN_INTERVAL_SECONDS)
+
+
+if __name__ == "__main__":
+    main()
+",
+  "apps/test_project/greengrass/my-component/recipe.yaml": "RecipeFormatVersion: '2020-01-25'
+ComponentName: com.proj.MyComponent
+ComponentVersion: 1.0.0
+ComponentDescription: com.proj.MyComponent Greengrass component using Python 3.14, generated by greengrass#component.
+ComponentPublisher: proj
+Manifests:
+  - Platform:
+      os: linux
+      architecture: aarch64
+    Artifacts:
+      # Placeholders are substituted at publish time. The basename must stay
+      # my-component.zip, which is what the Run script below unarchives to.
+      - Uri: s3://BUCKET_NAME/COMPONENT_NAME/COMPONENT_VERSION/my-component.zip
+        Unarchive: ZIP
+    Lifecycle:
+      Run: python3.14 {artifacts:decompressedPath}/my-component/main.py
+",
+  "apps/test_project/project.json": "{
+  "name": "test-project",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "apps/test_project/test_project",
+  "metadata": {
+    "components": [
+      {
+        "generator": "greengrass#component",
+        "path": "greengrass/my-component/main.py",
+        "name": "my-component",
+        "language": "python",
+        "componentName": "com.proj.MyComponent",
+        "componentVersion": "1.0.0",
+        "platform": "linux-arm64",
+        "ipc": false,
+        "gdkConfig": false
+      }
+    ]
+  },
+  "targets": {
+    "assemble": {
+      "dependsOn": ["my-component-artifact"]
+    },
+    "build": {
+      "dependsOn": ["my-component-artifact"]
+    },
+    "my-component-artifact": {
+      "executor": "nx:run-commands",
+      "dependsOn": ["my-component-vendor"],
+      "cache": true,
+      "inputs": [
+        "production",
+        "^production",
+        "{workspaceRoot}/packages/common/scripts/src/greengrass/**/*"
+      ],
+      "outputs": [
+        "{workspaceRoot}/dist/{projectRoot}/greengrass/my-component/greengrass-build"
+      ],
+      "options": {
+        "command": "tsx packages/common/scripts/src/greengrass/build-artifact.ts {projectRoot} my-component dist/{projectRoot}/greengrass/my-component"
+      }
+    },
+    "my-component-deploy-local": {
+      "executor": "nx:run-commands",
+      "dependsOn": ["my-component-artifact"],
+      "options": {
+        "command": "tsx packages/common/scripts/src/greengrass/deploy-local.ts dist/{projectRoot}/greengrass/my-component"
+      }
+    },
+    "my-component-logs": {
+      "executor": "nx:run-commands",
+      "continuous": true,
+      "options": {
+        "command": "tsx packages/common/scripts/src/greengrass/component-logs.ts com.proj.MyComponent"
+      }
+    },
+    "my-component-vendor": {
+      "executor": "nx:run-commands",
+      "dependsOn": ["compile"],
+      "cache": true,
+      "inputs": ["production", "^production"],
+      "outputs": [
+        "{workspaceRoot}/dist/{projectRoot}/greengrass/my-component/vendor"
+      ],
+      "options": {
+        "commands": [
+          "shx rm -rf dist/{projectRoot}/greengrass/my-component/vendor",
+          "shx mkdir -p dist/{projectRoot}/greengrass/my-component/vendor",
+          "uv export --frozen --no-dev --no-editable --no-emit-project --project {projectRoot} --package test-project -o dist/{projectRoot}/greengrass/my-component/vendor/requirements.txt",
+          "uv pip install -n --no-deps --no-installer-metadata --no-compile-bytecode --only-binary :all: --python-platform aarch64-manylinux_2_28 --python-version 3.14 --target dist/{projectRoot}/greengrass/my-component/vendor -r dist/{projectRoot}/greengrass/my-component/vendor/requirements.txt"
+        ],
+        "parallel": false
+      }
+    }
+  }
+}
+",
+  "apps/test_project/tests/greengrass/test_my_component.py": "import importlib.util
+from pathlib import Path
+
+# main.py lives beside recipe.yaml under greengrass/<component>/, outside this
+# project's importable package, so it is loaded directly by file path.
+PROJECT_ROOT = Path(__file__).resolve().parents[2]
+MAIN_PATH = PROJECT_ROOT / "greengrass" / "my-component" / "main.py"
+
+
+def _load_main():
+    spec = importlib.util.spec_from_file_location("my_component_main", MAIN_PATH)
+    assert spec is not None and spec.loader is not None
+    module = importlib.util.module_from_spec(spec)
+    spec.loader.exec_module(module)
+    return module
+
+
+def test_run_once_does_not_raise():
+    module = _load_main()
+    module.run_once(1)
+",
+  "packages/common/scripts/project.json": "{
+  "name": "@proj/common-scripts",
+  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "packages/common/scripts/src",
+  "projectType": "library",
+  "tags": [],
+  "metadata": {
+    "generator": "ts#project"
+  },
+  "targets": {
+    "assemble": {
+      "dependsOn": ["compile"]
+    },
+    "build": {
+      "dependsOn": ["lint", "compile", "test"]
+    },
+    "compile": {
+      "executor": "nx:run-commands",
+      "outputs": ["{workspaceRoot}/dist/{projectRoot}/tsc"],
+      "options": {
+        "command": "tsc --build tsconfig.lib.json",
+        "cwd": "{projectRoot}"
+      }
+    },
+    "format": {
+      "executor": "nx:run-commands",
+      "cache": true,
+      "inputs": ["biome"],
+      "options": {
+        "command": "biome format {projectRoot}"
+      },
+      "configurations": {
+        "fix": {
+          "command": "biome format --write {projectRoot}"
+        },
+        "skip-lint": {
+          "command": "node -e \\"\\""
+        }
+      }
+    },
+    "lint": {
+      "executor": "nx:run-commands",
+      "cache": true,
+      "inputs": ["biome"],
+      "dependsOn": ["format"],
+      "options": {
+        "command": "biome lint {projectRoot}"
+      },
+      "configurations": {
+        "fix": {
+          "command": "biome check --write {projectRoot}"
+        },
+        "skip-lint": {
+          "command": "node -e \\"\\""
+        }
+      }
+    }
+  }
+}
+",
+  "pnpm-workspace.yaml": "packages:
+  - packages/*
+  - packages/common/*
+catalog:
+  '@types/node': 26.6.5
+  vite: 8.3.4
+  vitest: 5.0.4
+  '@vitest/coverage-v8': 5.0.4
+  jsdom: 29.1.1
+  '@nx/vitest': 23.3.0
+  js-yaml: 4.3.2
+  '@types/js-yaml': 4.0.9
+  tsx: 4.23.15
+  shx: 0.4.0
+",
+}
+`;

package/src/greengrass/component/python/files/component/main.py.template

@@ -0,0 +1,60 @@
+<%_ if (ipc) { _%>
+import logging
+import time
+
+from awsiot.greengrasscoreipc.clientv2 import GreengrassCoreIPCClientV2
+from awsiot.greengrasscoreipc.model import JsonMessage, PublishMessage
+
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger("<%- componentName %>")
+
+TOPIC = "<%- componentName %>/heartbeat"
+PUBLISH_INTERVAL_SECONDS = 30
+
+
+def publish_heartbeat(client: GreengrassCoreIPCClientV2, sequence: int) -> None:
+    client.publish_to_topic(
+        topic=TOPIC,
+        publish_message=PublishMessage(
+            json_message=JsonMessage(message={"sequence": sequence})
+        ),
+    )
+    logger.info("Published heartbeat %s to %s", sequence, TOPIC)
+
+
+def main() -> None:
+    client = GreengrassCoreIPCClientV2()
+    sequence = 0
+    while True:
+        publish_heartbeat(client, sequence)
+        sequence += 1
+        time.sleep(PUBLISH_INTERVAL_SECONDS)
+
+
+if __name__ == "__main__":
+    main()
+<%_ } else { _%>
+import logging
+import time
+
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger("<%- componentName %>")
+
+RUN_INTERVAL_SECONDS = 30
+
+
+def run_once(sequence: int) -> None:
+    logger.info("<%- componentName %> heartbeat %s", sequence)
+
+
+def main() -> None:
+    sequence = 0
+    while True:
+        run_once(sequence)
+        sequence += 1
+        time.sleep(RUN_INTERVAL_SECONDS)
+
+
+if __name__ == "__main__":
+    main()
+<%_ } _%>

package/src/greengrass/component/python/files/component/recipe.yaml.template

@@ -0,0 +1,30 @@
+RecipeFormatVersion: '<%- recipeFormat %>'
+ComponentName: <%- componentName %>
+ComponentVersion: <%- version %>
+ComponentDescription: <%- componentDescription %>
+ComponentPublisher: <%- publisher %>
+<%_ if (ipc) { _%>
+ComponentConfiguration:
+  DefaultConfiguration:
+    accessControl:
+      aws.greengrass.ipc.pubsub:
+        <%- componentName %>:pubsub:1:
+          policyDescription: Allow publishing heartbeat messages to this component's own topic.
+          operations:
+            - aws.greengrass#PublishToTopic
+          resources:
+            - <%- componentName %>/heartbeat
+<%_ } _%>
+Manifests:
+<%_ manifests.forEach((m) => { _%>
+  - Platform:
+      os: <%- m.os %>
+      architecture: <%- m.architecture %>
+    Artifacts:
+      # Placeholders are substituted at publish time. The basename must stay
+      # <%- m.artifactBaseName %>.zip, which is what the Run script below unarchives to.
+      - Uri: s3://BUCKET_NAME/COMPONENT_NAME/COMPONENT_VERSION/<%- m.artifactBaseName %>.zip
+        Unarchive: ZIP
+    Lifecycle:
+      Run: python<%- pythonFloor %> {artifacts:decompressedPath}/<%- m.artifactBaseName %>/main.py
+<%_ }); _%>

package/src/greengrass/component/python/files/gdk/gdk-config.json.template

@@ -0,0 +1,13 @@
+{
+  "component": {
+    "<%- componentName %>": {
+      "author": "<%- publisher %>",
+      "version": "<%- version %>",
+      "build": {
+        "build_system": "custom",
+        "custom_build_command": ["nx", "run", "<%- project %>:<%- componentDirName %>-artifact"]
+      }
+    }
+  },
+  "gdk_version": "1.0.0"
+}

package/src/greengrass/component/python/files/tests/test___componentSnakeCase__.py.template

@@ -0,0 +1,37 @@
+import importlib.util
+from pathlib import Path
+
+# main.py lives beside recipe.yaml under greengrass/<component>/, outside this
+# project's importable package, so it is loaded directly by file path.
+PROJECT_ROOT = Path(__file__).resolve().parents[2]
+MAIN_PATH = PROJECT_ROOT / "greengrass" / "<%- componentDirName %>" / "main.py"
+
+
+def _load_main():
+    spec = importlib.util.spec_from_file_location("<%- componentSnakeCase %>_main", MAIN_PATH)
+    assert spec is not None and spec.loader is not None
+    module = importlib.util.module_from_spec(spec)
+    spec.loader.exec_module(module)
+    return module
+
+<%_ if (ipc) { _%>
+
+def test_publish_heartbeat_publishes_to_own_topic():
+    module = _load_main()
+    calls = []
+
+    class FakeClient:
+        def publish_to_topic(self, **kwargs):
+            calls.append(kwargs)
+
+    module.publish_heartbeat(FakeClient(), 1)
+
+    assert len(calls) == 1
+    assert calls[0]["topic"] == module.TOPIC
+    assert module.TOPIC == "<%- componentName %>/heartbeat"
+<%_ } else { _%>
+
+def test_run_once_does_not_raise():
+    module = _load_main()
+    module.run_once(1)
+<%_ } _%>

package/src/greengrass/component/python/generator.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { type GeneratorCallback, type Tree } from '@nx/devkit';
+import type { NormalizedComponent } from '../common.js';
+/**
+ * Generates an AWS IoT Greengrass v2 component on an existing Python project:
+ * packaging and local-deployment targets (`<c>-vendor`, `<c>-artifact`,
+ * `<c>-deploy-local`, `<c>-logs`), plus, unless `--infra none`, a
+ * `GreengrassComponentVersion` CDK construct (or Terraform module, via the
+ * `hashicorp/awscc` provider) that publishes the built artifact.
+ */
+export declare const pythonGreengrassComponentGenerator: (tree: Tree, component: NormalizedComponent) => Promise<GeneratorCallback>;
+export default pythonGreengrassComponentGenerator;