Update main.yml

Bumps [actions/checkout](https://github.com/actions/checkout) from 4.1.6 to 4.1.7.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v4.1.6...v4.1.7)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.env.example

@@ -1 +1,4 @@
-SPECKLE_TOKEN=mytoken
+SPECKLE_TOKEN="mytoken"
+SPECKLE_SERVER_URL="http://127.0.0.1:3000"
+SPECKLE_PROJECT_ID=""
+SPECKLE_AUTOMATION_ID=""

.github/workflows/main.yml

@@ -11,27 +11,29 @@ jobs:
       FUNCTION_SCHEMA_FILE_NAME: functionSchema.json
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4.1.1
+      - uses: actions/checkout@v4.1.7
       - uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-      - name: Install and configure Poetry
-        uses: snok/install-poetry@v1
-        with:
-          version: 1.3.2
-          virtualenvs-create: false
-          virtualenvs-in-project: false
-          installer-parallel: true
+      - name: Install poetry
+        run: |
+          pip install poetry==1.8.4 &&
+          poetry config virtualenvs.create false &&
+          poetry config virtualenvs.in-project false &&
+          poetry config installer.parallel true
       - name: Restore dependencies
         run: poetry install --no-root
       - name: Extract functionInputSchema
         id: extract_schema
         run: |
-          python main.py generate_schema ${HOME}/${{ env.FUNCTION_SCHEMA_FILE_NAME }}
+          python main.py generate_schema "${HOME}/${{ env.FUNCTION_SCHEMA_FILE_NAME }}"
+          echo "Checking if functionSchema.json exists after generation..."
+          ls -lah "${HOME}/${{ env.FUNCTION_SCHEMA_FILE_NAME }}"
+
       - name: Speckle Automate Function - Build and Publish
-        uses: specklesystems/speckle-automate-github-composite-action@0.8.0
+        uses: specklesystems/speckle-automate-github-composite-action@0.8.1
         with:
-          speckle_automate_url: ${{ env.SPECKLE_AUTOMATE_URL || 'https://automate.speckle.dev' }} 
+          speckle_automate_url: ${{ env.SPECKLE_AUTOMATE_URL || vars.SPECKLE_AUTOMATE_URL || 'https://automate.speckle.dev' }}
           speckle_token: ${{ secrets.SPECKLE_FUNCTION_TOKEN }}
           speckle_function_id: ${{ secrets.SPECKLE_FUNCTION_ID }}
           speckle_function_input_schema_file_path: ${{ env.FUNCTION_SCHEMA_FILE_NAME }}

.vscode/launch.json

@@ -6,7 +6,7 @@
   "configurations": [
     {
       "name": "Speckle Automate function",
-      "type": "python",
+      "type": "debugpy",
       "request": "launch",
       "program": "main.py",
       "console": "integratedTerminal",

Dockerfile

@@ -2,7 +2,7 @@
 FROM python:3.11-slim
 
 # We install poetry to generate a list of dependencies which will be required by our application
-RUN pip install poetry
+RUN pip install poetry==1.8.4
 
 # We set the working directory to be the /home/speckle directory; all of our files will be copied here.
 WORKDIR /home/speckle

README.md

@@ -1,10 +1,10 @@
 # Speckle Automate function template - Python
 
-This is a template repository for a Speckle Automate functions written in python
+This template repository is for a Speckle Automate function written in Python
 using the [specklepy](https://pypi.org/project/specklepy/) SDK to interact with Speckle data.
 
-This template contains the full scaffolding required to publish a function to the automate environment.
-Also has some sane defaults for a development environment setups.
+This template contains the full scaffolding required to publish a function to the Automate environment.
+It also has some sane defaults for development environment setups.
 
 ## Getting started
 
@@ -14,12 +14,12 @@ Register the function
 
 ### Add new dependencies
 
-To add new python package dependencies to the project, use:
+To add new Python package dependencies to the project, use the following:
 `$ poetry add pandas`
 
 ### Change launch variables
 
-describe how the launch.json should be edited
+Describe how the launch.json should be edited.
 
 ### Github Codespaces
 
@@ -29,15 +29,15 @@ Create a new repo from this template, and use the create new code.
 
 1. [Create](https://automate.speckle.dev/) a new Speckle Automation.
 1. Select your Speckle Project and Speckle Model.
-1. Select the existing Speckle Function named [`Random comment on IFC beam`](https://automate.speckle.dev/functions/e110be8fad).
+1. Select the deployed Speckle Function.
 1. Enter a phrase to use in the comment.
 1. Click `Create Automation`.
 
-## Getting Started with creating your own Speckle Function
+## Getting Started with Creating Your Own Speckle Function
 
 1. [Register](https://automate.speckle.dev/) your Function with [Speckle Automate](https://automate.speckle.dev/) and select the Python template.
 1. A new repository will be created in your GitHub account.
-1. Make changes to your Function in `main.py`. See below for the Developer Requirements, and instructions on how to test.
+1. Make changes to your Function in `main.py`. See below for the Developer Requirements and instructions on how to test.
 1. To create a new version of your Function, create a new [GitHub release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) in your repository.
 
 ## Developer Requirements
@@ -53,13 +53,13 @@ The code can be tested locally by running `poetry run pytest`.
 
 ### Building and running the Docker Container Image
 
-Running and testing your code on your own machine is a great way to develop your Function; the following instructions are a bit more in-depth and only required if you are having issues with your Function in GitHub Actions or on Speckle Automate.
+Running and testing your code on your machine is a great way to develop your Function; the following instructions are a bit more in-depth and only required if you are having issues with your Function in GitHub Actions or on Speckle Automate.
 
 #### Building the Docker Container Image
 
-Your code is packaged by the GitHub Action into the format required by Speckle Automate. This is done by building a Docker Image, which is then run by Speckle Automate. You can attempt to build the Docker Image yourself to test the building process locally.
+The GitHub Action packages your code into the format required by Speckle Automate. This is done by building a Docker Image, which Speckle Automate runs. You can attempt to build the Docker Image locally to test the building process.
 
-To build the Docker Container Image, you will need to have [Docker](https://docs.docker.com/get-docker/) installed.
+To build the Docker Container Image, you must have [Docker](https://docs.docker.com/get-docker/) installed.
 
 Once you have Docker running on your local machine:
 
@@ -73,7 +73,7 @@ Once you have Docker running on your local machine:
 
 #### Running the Docker Container Image
 
-Once the image has been built by the GitHub Action, it is sent to Speckle Automate. When Speckle Automate runs your Function as part of an Automation, it will run the Docker Container Image. You can test that your Docker Container Image runs correctly by running it locally.
+Once the GitHub Action has built the image, it is sent to Speckle Automate. When Speckle Automate runs your Function as part of an Automation, it will run the Docker Container Image. You can test that your Docker Container Image runs correctly locally.
 
 1. To then run the Docker Container Image, run the following command:
 
@@ -87,14 +87,14 @@ Once the image has been built by the GitHub Action, it is sent to Speckle Automa
 
 Let's explain this in more detail:
 
-`docker run --rm speckle_automate_python_example` tells Docker to run the Docker Container Image that we built earlier. `speckle_automate_python_example` is the name of the Docker Container Image that we built earlier. The `--rm` flag tells docker to remove the container after it has finished running, this frees up space on your machine.
+`docker run—-rm speckle_automate_python_example` tells Docker to run the Docker Container Image we built earlier. `speckle_automate_python_example` is the name of the Docker Container Image. The `--rm` flag tells Docker to remove the container after it has finished running, freeing up space on your machine.
 
-The line `python -u main.py run` is the command that is run inside the Docker Container Image. The rest of the command is the arguments that are passed to the command. The arguments are:
+The line `python -u main.py run` is the command run inside the Docker Container Image. The rest of the command is the arguments passed to the command. The arguments are:
 
 - `'{"projectId": "1234", "modelId": "1234", "branchName": "myBranch", "versionId": "1234", "speckleServerUrl": "https://speckle.xyz", "automationId": "1234", "automationRevisionId": "1234", "automationRunId": "1234", "functionId": "1234", "functionName": "my function", "functionLogo": "base64EncodedPng"}'` - the metadata that describes the automation and the function.
-- `{}` - the input parameters for the function that the Automation creator is able to set. Here they are blank, but you can add your own parameters to test your function.
-- `yourSpeckleServerAuthenticationToken` - the authentication token for the Speckle Server that the Automation can connect to. This is required to be able to interact with the Speckle Server, for example to get data from the Model.
+- `{}` - the input parameters for the function the Automation creator can set. Here, they are blank, but you can add your parameters to test your function.
+- `yourSpeckleServerAuthenticationToken`—the authentication token for the Speckle Server that the Automation can connect to. This is required to interact with the Speckle Server, for example, to get data from the Model.
 
 ## Resources
 
-- [Learn](https://speckle.guide/dev/python.html) more about SpecklePy, and interacting with Speckle from Python.
+- [Learn](https://speckle.guide/dev/python.html) more about SpecklePy and interacting with Speckle from Python.

example.function_inputs.json

@@ -2,19 +2,19 @@
   "speckleToken": "YOUR SPEKCLE TOKEN",
   "functionInputs": {
     "whisperMessage": "you are doing something weird",
-    "forbiddenSpeckleType": ""
+    "forbiddenSpeckleType": "wall"
   },
   "automationRunData": {
     "project_id": "project id",
-    "model_id": "model id",
-    "branch_name": "branch name",
-    "version_id": "version id",
     "speckle_server_url": "https://latest.speckle.systems",
     "automation_id": "automation id",
-    "automation_revision_id": "automation revision id",
     "automation_run_id": "automation run id",
-    "function_id": "function id",
-    "function_name": "function name",
-    "function_logo": null
+    "function_run_id": "function run id",
+    "triggers": [
+      {
+        "payload": { "modelId": "model id", "versionId": "version id" },
+        "triggerType": "versionCreation"
+      }
+    ]
   }
 }

flatten.py

@@ -6,8 +6,22 @@ from specklepy.objects import Base
 
 
 def flatten_base(base: Base) -> Iterable[Base]:
-    """Take a base and flatten it to an iterable of bases."""
-    if hasattr(base, "elements"):
-        for element in base["elements"]:
+    """Flatten a base object into an iterable of bases.
+    
+    This function recursively traverses the `elements` or `@elements` attribute of the 
+    base object, yielding each nested base object.
+
+    Args:
+        base (Base): The base object to flatten.
+
+    Yields:
+        Base: Each nested base object in the hierarchy.
+    """
+    # Attempt to get the elements attribute, fallback to @elements if necessary
+    elements = getattr(base, "elements", getattr(base, "@elements", None))
+    
+    if elements is not None:
+        for element in elements:
             yield from flatten_base(element)
+    
     yield base

main.py

@@ -1,6 +1,6 @@
-"""This module contains the business logic of the function.
+"""This module contains the function's business logic.
 
-Use the automation_context module to wrap your function in an Autamate context helper
+Use the automation_context module to wrap your function in an Automate context helper.
 """
 
 from pydantic import Field, SecretStr
@@ -14,14 +14,14 @@ from flatten import flatten_base
 
 
 class FunctionInputs(AutomateBase):
-    """These are function author defined values.
+    """These are function author-defined values.
 
     Automate will make sure to supply them matching the types specified here.
     Please use the pydantic model schema to define your inputs:
     https://docs.pydantic.dev/latest/usage/models/
     """
 
-    # an example how to use secret values
+    # An example of how to use secret values.
     whisper_message: SecretStr = Field(title="This is a secret message")
     forbidden_speckle_type: str = Field(
         title="Forbidden speckle type",
@@ -39,13 +39,13 @@ def automate_function(
     """This is an example Speckle Automate function.
 
     Args:
-        automate_context: A context helper object, that carries relevant information
+        automate_context: A context-helper object that carries relevant information
             about the runtime context of this function.
-            It gives access to the Speckle project data, that triggered this run.
-            It also has conveniece methods attach result data to the Speckle model.
+            It gives access to the Speckle project data that triggered this run.
+            It also has convenient methods for attaching result data to the Speckle model.
         function_inputs: An instance object matching the defined schema.
     """
-    # the context provides a conveniet way, to receive the triggering version
+    # The context provides a convenient way to receive the triggering version.
     version_root_object = automate_context.receive_version()
 
     objects_with_forbidden_speckle_type = [
@@ -56,10 +56,10 @@ def automate_function(
     count = len(objects_with_forbidden_speckle_type)
 
     if count > 0:
-        # this is how a run is marked with a failure cause
+        # This is how a run is marked with a failure cause.
         automate_context.attach_error_to_objects(
             category="Forbidden speckle_type"
-            " ({function_inputs.forbidden_speckle_type})",
+            f" ({function_inputs.forbidden_speckle_type})",
             object_ids=[o.id for o in objects_with_forbidden_speckle_type if o.id],
             message="This project should not contain the type: "
             f"{function_inputs.forbidden_speckle_type}",
@@ -70,15 +70,15 @@ def automate_function(
             f"{function_inputs.forbidden_speckle_type}"
         )
 
-        # set the automation context view, to the original model / version view
-        # to show the offending objects
+        # Set the automation context view to the original model/version view
+        # to show the offending objects.
         automate_context.set_context_view()
 
     else:
         automate_context.mark_run_success("No forbidden types found.")
 
-    # if the function generates file results, this is how it can be
-    # attached to the Speckle project / model
+    # If the function generates file results, this is how it can be
+    # attached to the Speckle project/model
     # automate_context.store_file_result("./report.pdf")
 
 
@@ -94,10 +94,10 @@ def automate_function_without_inputs(automate_context: AutomationContext) -> Non
 
 # make sure to call the function with the executor
 if __name__ == "__main__":
-    # NOTE: always pass in the automate function by its reference, do not invoke it!
+    # NOTE: always pass in the automate function by its reference; do not invoke it!
 
-    # pass in the function reference with the inputs schema to the executor
+    # Pass in the function reference with the inputs schema to the executor.
     execute_automate_function(automate_function, FunctionInputs)
 
-    # if the function has no arguments, the executor can handle it like so
+    # If the function has no arguments, the executor can handle it like so
     # execute_automate_function(automate_function_without_inputs)

pyproject.toml

@@ -4,15 +4,17 @@ version = "0.1.0"
 description = "Example function for Speckle Automate using specklepy"
 authors = ["Gergő Jedlicska <gergo@jedlicska.com>"]
 readme = "README.md"
+package-mode = false
 
 [tool.poetry.dependencies]
 python = "^3.11"
-specklepy = "2.17.17"
+specklepy = "^2.21.0"
 
 [tool.poetry.group.dev.dependencies]
 black = "^23.3.0"
 mypy = "^1.3.0"
 ruff = "^0.0.271"
+pydantic-settings = "^2.3.0"
 pytest = "^7.4.2"
 # specklepy = { path = "../specklepy", develop = true }
 

tests/test_function.py

@@ -1,168 +1,31 @@
 """Run integration tests with a speckle server."""
-import os
-import secrets
-import string
 
-from specklepy.logging.exceptions import SpeckleException
+from pydantic import SecretStr
 
-import pytest
-from gql import gql
 from speckle_automate import (
     AutomationContext,
     AutomationRunData,
     AutomationStatus,
-    run_function,
+    run_function
 )
-from specklepy.api import operations
-from specklepy.api.client import SpeckleClient
-from specklepy.objects.base import Base
-from specklepy.transports.server import ServerTransport
 
 from main import FunctionInputs, automate_function
 
-
-def crypto_random_string(length: int) -> str:
-    """Generate a semi crypto random string of a given length."""
-    alphabet = string.ascii_letters + string.digits
-    return "".join(secrets.choice(alphabet) for _ in range(length))
+from speckle_automate.fixtures import *
 
 
-def register_new_automation(
-    project_id: str,
-    model_id: str,
-    speckle_client: SpeckleClient,
-    automation_id: str,
-    automation_name: str,
-    automation_revision_id: str,
-):
-    """Register a new automation in the speckle server."""
-    query = gql(
-        """
-        mutation CreateAutomation(
-            $projectId: String! 
-            $modelId: String! 
-            $automationName: String!
-            $automationId: String! 
-            $automationRevisionId: String!
-        ) {
-                automationMutations {
-                    create(
-                        input: {
-                            projectId: $projectId
-                            modelId: $modelId
-                            automationName: $automationName 
-                            automationId: $automationId
-                            automationRevisionId: $automationRevisionId
-                        }
-                    )
-                }
-            }
-        """
-    )
-    params = {
-        "projectId": project_id,
-        "modelId": model_id,
-        "automationName": automation_name,
-        "automationId": automation_id,
-        "automationRevisionId": automation_revision_id,
-    }
-    speckle_client.httpclient.execute(query, params)
-
-
-@pytest.fixture()
-def speckle_token() -> str:
-    """Provide a speckle token for the test suite."""
-    env_var = "SPECKLE_TOKEN"
-    token = os.getenv(env_var)
-    if not token:
-        raise ValueError(f"Cannot run tests without a {env_var} environment variable")
-    return token
-
-
-@pytest.fixture()
-def speckle_server_url() -> str:
-    """Provide a speckle server url for the test suite, default to localhost."""
-    return os.getenv("SPECKLE_SERVER_URL", "http://127.0.0.1:3000")
-
-
-@pytest.fixture()
-def test_client(speckle_server_url: str, speckle_token: str) -> SpeckleClient:
-    """Initialize a SpeckleClient for testing."""
-    test_client = SpeckleClient(
-        speckle_server_url, speckle_server_url.startswith("https")
-    )
-    test_client.authenticate_with_token(speckle_token)
-    return test_client
-
-
-@pytest.fixture()
-def test_object() -> Base:
-    """Create a Base model for testing."""
-    root_object = Base()
-    root_object.foo = "bar"
-    return root_object
-
-
-@pytest.fixture()
-def automation_run_data(
-    test_object: Base, test_client: SpeckleClient, speckle_server_url: str
-) -> AutomationRunData:
-    """Set up an automation context for testing."""
-    project_id = test_client.stream.create("Automate function e2e test")
-    branch_name = "main"
-
-    model = test_client.branch.get(project_id, branch_name, commits_limit=1)
-    model_id: str = model.id
-
-    root_obj_id = operations.send(
-        test_object, [ServerTransport(project_id, test_client)]
-    )
-    version_id = test_client.commit.create(project_id, root_obj_id)
-    if isinstance(version_id, SpeckleException):
-        raise version_id
-
-    automation_name = crypto_random_string(10)
-    automation_id = crypto_random_string(10)
-    automation_revision_id = crypto_random_string(10)
-
-    register_new_automation(
-        project_id,
-        model_id,
-        test_client,
-        automation_id,
-        automation_name,
-        automation_revision_id,
-    )
-
-    automation_run_id = crypto_random_string(10)
-    function_id = crypto_random_string(10)
-    function_revision = crypto_random_string(10)
-    return AutomationRunData(
-        project_id=project_id,
-        model_id=model_id,
-        branch_name=branch_name,
-        version_id=version_id,
-        speckle_server_url=speckle_server_url,
-        automation_id=automation_id,
-        automation_revision_id=automation_revision_id,
-        automation_run_id=automation_run_id,
-        function_id=function_id,
-        function_name=crypto_random_string(10),
-        function_logo=None,
-    )
-
-
-def test_function_run(automation_run_data: AutomationRunData, speckle_token: str):
+def test_function_run(test_automation_run_data: AutomationRunData, test_automation_token: str):
     """Run an integration test for the automate function."""
     automation_context = AutomationContext.initialize(
-        automation_run_data, speckle_token
+        test_automation_run_data, test_automation_token
     )
     automate_sdk = run_function(
         automation_context,
         automate_function,
         FunctionInputs(
-            forbidden_speckle_type="Base", whisper_message="testing automatically"
+            forbidden_speckle_type="None",
+            whisper_message=SecretStr("testing automatically"),
         ),
     )
 
-    assert automate_sdk.run_status == AutomationStatus.FAILED
+    assert automate_sdk.run_status == AutomationStatus.SUCCEEDED