[dg docs] Add docs e2e test, screenshot generation for component type tutorial

Author: benpankow

docs/docs-beta/src/code-examples-content.js

@@ -1,5 +1,5 @@
 ---
-title: 'Creating a New Component Type'
+title: 'Creating a new component type'
 sidebar_position: 100
 ---
 
@@ -36,13 +36,11 @@ For this example, we'll write a lightweight component that executes a shell comm
 
 First, we use the `dg` command-line utility to scaffold a new component type:
 
-```bash
-dg component-type generate shell_command
-```
+<CliInvocationExample path="docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/1-dg-scaffold-shell-command.txt" />
 
 This will add a new file to your project in the `lib` directory:
 
-<CodeExample path="docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/empty.py" language="python" />
+<CodeExample path="docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/2-shell-command-empty.py" language="python" title="my_component_library/lib/shell_command.py" />
 
 This file contains the basic structure for the new component type. There are two methods that you'll need to implement:
 
@@ -88,18 +86,15 @@ Our `build_defs` method will create a single `@asset` that executes the provided
 
 Following the steps above will automatically register your component type in your environment. You can now run:
 
-```bash
-dg component-type list
-```
+<CliInvocationExample path="docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/3-dg-list-component-types.txt" />
 
 and see your new component type in the list of available component types.
 
 You can also view automatically generated documentation describing your new component type by running:
 
-```bash
-dg component-type docs your_library.shell_command
-```
+<CliInvocationExample path="docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/4-dg-component-type-docs.txt" />
 
+![](/images/guides/build/projects-and-components/components/component-type-docs.png)
 ## [Advanced] Custom templating
 
 The components system supports a rich templating syntax that allows you to load arbitrary Python values based off of your `component.yaml` file.
@@ -140,4 +135,4 @@ params:
 
 ## Next steps
 
-- Add a new component to your project
+- [Add a new component to your project](./using-a-component.md)

docs/docs/guides/preview/components/creating-a-component.md

@@ -0,0 +1,4 @@
+dg component-type scaffold shell_command
+
+Creating a Dagster component type at /.../my-component-library/my_component_library/lib/shell_command.py.
+Scaffolded files for Dagster project in /.../my-component-library/my_component_library/lib.

docs/static/images/guides/build/projects-and-components/components/component-type-docs.png

@@ -0,0 +1,39 @@
+from dagster import Definitions
+from dagster_components import (
+    Component,
+    ComponentLoadContext,
+    DefaultComponentScaffolder,
+    registered_component_type,
+)
+from pydantic import BaseModel
+
+class ShellCommandParams(BaseModel):
+    ...
+
+@registered_component_type(name="shell_command")
+class ShellCommand(Component):
+    """COMPONENT SUMMARY HERE.
+
+    COMPONENT DESCRIPTION HERE.
+    """
+
+    @classmethod
+    def get_schema(cls):
+        return ShellCommandParams
+
+    @classmethod
+    def get_scaffolder(cls) -> DefaultComponentScaffolder:
+        return DefaultComponentScaffolder()
+
+    @classmethod
+    def load(
+        cls,
+        params: ShellCommandParams,
+        context: ComponentLoadContext,
+    ) -> "ShellCommand":
+        # Add logic for mapping schema parameters to constructor args here.
+        return cls()
+
+    def build_defs(self, load_context: ComponentLoadContext) -> Definitions:
+        # Add definition construction logic here.
+        return Definitions()

examples/docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/1-dg-scaffold-shell-command.txt

@@ -0,0 +1,14 @@
+dg component-type list
+
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ Component Type                                        ┃ Summary                        ┃
+┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
+│ definitions@dagster_components                        │ Wraps an arbitrary set of      │
+│                                                       │ Dagster definitions.           │
+│ pipes_subprocess_script_collection@dagster_components │ Assets that wrap Python        │
+│                                                       │ scripts executed with          │
+│                                                       │ Dagster's                      │
+│                                                       │ PipesSubprocessClient.         │
+│ shell_command@my_component_library                    │ Models a shell script as a     │
+│                                                       │ Dagster asset.                 │
+└───────────────────────────────────────────────────────┴────────────────────────────────┘

examples/docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/2-shell-command-empty.py

@@ -0,0 +1 @@
+dg component-type docs shell_command@my_component_library

examples/docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/3-dg-list-component-types.txt

@@ -0,0 +1,40 @@
+
+    <!DOCTYPE html>
+    <html lang="en">
+    <head>
+        <meta charset="UTF-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <title>Markdown Preview</title>
+    </head>
+    <body>
+        <h2>Component: <code>my_component_library.shell_command</code></h2>
+<h3>Description:</h3>
+<p>Models a shell script as a Dagster asset.</p>
+<h3>Sample Component Params:</h3>
+<textarea rows=24 cols=100>
+type: my_component_library.shell_command
+
+params:
+  script_path: '...'
+  asset_attributes:
+    deps:
+      - '...'
+    description: '...'
+    metadata: '...'
+    group_name: '...'
+    skippable: false
+    code_version: '...'
+    owners:
+      - '...'
+    tags: '...'
+    kinds:
+      - '...'
+    automation_condition: '...'
+    key: '...'
+  op:
+    name: '...'
+    tags: {}
+
+</textarea>
+    </body>
+    </html>

examples/docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/4-dg-component-type-docs.txt

@@ -0,0 +1,3 @@
+type: shell_command@my_component_library
+
+params: {}

examples/docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/5-dg-component-type-docs.html

@@ -24,7 +24,7 @@ def __init__(self, params):
     def build_defs(self, load_context: ComponentLoadContext) -> dg.Definitions:
         # highlight-start
         # resolve the script runner with its required additional scope
-        script_runner = self.params.resolve_properties(
+        script_runner = self.params.resolve(
             load_context.templated_value_resolver.with_scope(
                 get_script_runner=_get_script_runner
             )

examples/docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/6-scaffolded-component.yaml

@@ -22,6 +22,8 @@ class ShellScriptSchema(BaseModel):
 
 @registered_component_type(name="shell_command")
 class ShellCommand(Component):
+    """Models a shell script as a Dagster asset."""
+
     def __init__(self, params: ShellScriptSchema):
         self.params = params
 
@@ -38,11 +40,11 @@ def load(
         return cls(params=params)
 
     def build_defs(self, load_context: ComponentLoadContext) -> dg.Definitions:
-        resolved_asset_attributes = self.params.asset_attributes.resolve_properties(
+        resolved_asset_attributes = self.params.asset_attributes.resolve(
             load_context.templated_value_resolver
         )
         resolved_op_properties = (
-            self.params.op.resolve_properties(load_context.templated_value_resolver)
+            self.params.op.resolve(load_context.templated_value_resolver)
             if self.params.op
             else {}
         )

examples/docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/resolving-resolvable-field.py

@@ -21,6 +21,8 @@ class ShellScriptSchema(BaseModel):
 
 @registered_component_type(name="shell_command")
 class ShellCommand(Component):
+    """Models a shell script as a Dagster asset."""
+
     @classmethod
     def get_schema(cls) -> type[ShellScriptSchema]:
         # higlight-start

examples/docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/with-build-defs.py

@@ -1,3 +1,5 @@
+from collections.abc import Iterator
+
 import pytest
 
 
@@ -11,3 +13,23 @@ def pytest_addoption(parser: pytest.Parser) -> None:
 @pytest.fixture
 def update_snippets(request: pytest.FixtureRequest) -> bool:
     return bool(request.config.getoption("--update-snippets"))
+
+
+@pytest.fixture(scope="session")
+def get_selenium_driver():
+    from selenium import webdriver
+
+    driver = None
+
+    try:
+
+        def _get_driver():
+            nonlocal driver
+            if driver is None:
+                driver = webdriver.Chrome()
+            return driver
+
+        yield _get_driver
+    finally:
+        if driver:
+            driver.quit()