cs-image-system-local-state-plugin 0.1.1__py3-none-any.whl

cs_image_system/local_state_plugin/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2026 Mykel Alvis <mykelalvis@infrastructurebuilder.org>
+#
+# SPDX-License-Identifier: Apache-2.0

cs_image_system/local_state_plugin/local_state_builder.py

@@ -0,0 +1,20 @@
+# SPDX-FileCopyrightText: 2026 Mykel Alvis <mykelalvis@infrastructurebuilder.org>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from typing import TypeVar
+
+from cs_image_system.base.basic.builder_base_state import StateBuilderBase
+
+from .local_state_models import LOCAL_STATE, LocalStateBuilderModel
+
+Q = TypeVar("Q", bound=LocalStateBuilderModel)
+
+
+class LocalStateBuilder(StateBuilderBase[Q]):
+    """The local backend's builder: it emits nothing and runs nothing; the
+    consumers do, through the collector (like the S3 builder)."""
+
+    @classmethod
+    def csis_name(cls) -> str:
+        return LOCAL_STATE

cs_image_system/local_state_plugin/local_state_models.py

@@ -0,0 +1,122 @@
+# SPDX-FileCopyrightText: 2026 Mykel Alvis <mykelalvis@infrastructurebuilder.org>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""The ``local`` state backend type (stage 47.3): a state file on disk.
+
+The type that needs nothing -- no bucket, no cloud, no credentials -- so a
+developer or a test can run a real ``tofu init`` against it. An entry
+declares a directory (``path``, relative to the configuration root or
+absolute); a workspace's state is ``<path>/<workspace>.tfstate`` in it. The
+root that binds to it sits a fixed four directories below the configuration
+root (``generated/<lifecycle>/<workspace>/<phase>/``), so a relative
+directory is written into the backend file relative to that depth, and the
+emission names no absolute path of the machine that generated it.
+"""
+from __future__ import annotations
+
+import re
+from typing import Any, Mapping
+
+from pydantic.dataclasses import dataclass  # stage 23: validation at construction
+
+from cs_image_system.base.constants import VCT
+from cs_image_system.base.models.model_config import CSIS_MODEL_CONFIG
+from cs_image_system.base.models.state_builder import StateBuilderModel
+from cs_image_system.base.utils import super_safe_name
+from cs_image_system.hashicorp_utils.collector import BackendRegistration, StateLocation, TerraformCollector
+
+LOCAL_STATE: str = "local"
+ROOT_DEPTH = 4     # generated/<lifecycle>/<workspace>/<phase>/ below the configuration root
+_SLASHES = re.compile(r"/{2,}")
+
+
+class LocalBackendKind:
+    """The local type's renderings: the location is ``local://<directory>/
+    <workspace>.tfstate``; the backend file and a consumer's data source
+    both carry one setting, ``path``."""
+    type = LOCAL_STATE
+
+    @staticmethod
+    def directory(settings: Mapping[str, Any]) -> str:
+        """The declared directory, normalised: repeated slashes collapsed, a
+        leading ``./`` and a trailing slash dropped, an absolute path kept."""
+        path = _SLASHES.sub("/", str(settings.get("path") or "."))
+        while path.startswith("./"):
+            path = path[2:]
+        path = path.rstrip("/") if len(path) > 1 else path
+        return path or "."
+
+    def location(self, settings: Mapping[str, Any], workspace: str) -> StateLocation:
+        return StateLocation(type=self.type, container=self.directory(settings),
+                             key=f"{super_safe_name(workspace)}.tfstate")
+
+    def state_path(self, settings: Mapping[str, Any], workspace: str) -> str:
+        """What a root writes into its backend file: an absolute directory as
+        declared; a relative one rewritten from the root directory's depth."""
+        loc = self.location(settings, workspace)
+        if loc.container.startswith("/"):
+            return f"{loc.container}/{loc.key}"
+        climb = "../" * ROOT_DEPTH
+        return f"{climb}{loc.key}" if loc.container == "." else f"{climb}{loc.container}/{loc.key}"
+
+    def backend_settings(self, settings: Mapping[str, Any], workspace: str) -> dict[str, Any]:
+        return {"path": self.state_path(settings, workspace)}
+
+    def remote_state_settings(self, settings: Mapping[str, Any], workspace: str) -> dict[str, Any]:
+        return {"path": self.state_path(settings, workspace)}
+
+
+LOCAL_KIND = LocalBackendKind()
+
+
+@dataclass(kw_only=True, config=CSIS_MODEL_CONFIG)
+class LocalStateBuilderModel(StateBuilderModel):
+    """A ``local`` entry under ``state_backends:``."""
+    path: str = "state"
+    type = LOCAL_STATE
+    # the executables entry these roots run; None = unspecified (no version
+    # check), a declared name is checked like every builder's (stage 63)
+    executable: str | None = None
+
+    @classmethod
+    def csis_name(cls) -> str:
+        return LOCAL_STATE
+
+    @classmethod
+    def csis_classifier(cls) -> VCT:
+        return VCT.STATE_BACKEND_MODEL
+
+    def __post_init__(self) -> None:
+        if not self.path or not self.path.strip():
+            raise ValueError("Terraform state backend 'path' cannot be empty for 'local' type.")
+        self.path = self.path.strip()
+        # stage 63: one directory has one spelling. `a/../b` and `b` were two
+        # locations to the collision check, and a bare `/` rendered
+        # `//<ws>.tfstate` (state files in the filesystem root)
+        normalised = LOCAL_KIND.directory({"path": self.path})
+        parts = [s for s in normalised.split("/") if s]
+        # `.` alone is the configuration root itself (a supported place);
+        # only a `.` or `..` INSIDE a longer path, or `..` anywhere, is refused
+        if normalised != "." and any(s in (".", "..") for s in parts):
+            raise ValueError(f"state backend {self.name!r}: `path: {self.path}` has a `.` or `..` "
+                             "segment; write the directory once, without them")
+        if normalised == "/":
+            raise ValueError(f"state backend {self.name!r}: `path: /` would put state files in the "
+                             "filesystem root; name a directory")
+        super().__post_init__()
+
+    def to_backend_registration(self) -> BackendRegistration:
+        return BackendRegistration(name=self.name, type=self.type_, settings={"path": self.path},
+                                   kind=LOCAL_KIND, is_default=self.get_is_default(),
+                                   aliases=tuple(sorted(self.aliases or ())))
+
+    def get_state_file_path(self, builder_name: str) -> str:
+        return self.to_backend_registration().state_file_path(builder_name)
+
+    def finalize(self) -> None:
+        if self._finalized:
+            return
+        super().finalize()
+        # available run-wide, like the S3 backend: consumers resolve it by name or as the default
+        TerraformCollector().register_backend(self.to_backend_registration())

cs_image_system/local_state_plugin/main.py

@@ -0,0 +1,25 @@
+# SPDX-FileCopyrightText: 2026 Mykel Alvis <mykelalvis@infrastructurebuilder.org>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import logging
+
+from cs_image_system.base.basic.abstract_plugin_metadata import AbstractPluginMetadata
+from cs_image_system.base.protocols.plugin_metadata import PluginMetadataProtocol
+
+from .local_state_builder import LocalStateBuilder
+from .local_state_models import LOCAL_STATE, LocalStateBuilderModel
+
+log = logging.getLogger(__name__)
+
+
+class LocalStateTypes(AbstractPluginMetadata, PluginMetadataProtocol):
+    def __init__(self) -> None:
+        super().__init__("1", "3.13",
+                         {LOCAL_STATE: [LocalStateBuilderModel, LocalStateBuilder]},
+                         {LocalStateBuilderModel: LocalStateBuilder})
+
+
+def initialize():
+    log.debug("Initializing local state provider")
+    return LocalStateTypes()

cs_image_system_local_state_plugin-0.1.1.dist-info/METADATA

@@ -0,0 +1,518 @@
+Metadata-Version: 2.5
+Name: cs-image-system-local-state-plugin
+Version: 0.1.1
+Summary: The local state backend plugin: a state file on disk for every terraform root that names it; no cloud, no credentials
+Project-URL: Repository, https://github.com/infrastructurebuilder/cs-image-system-3
+Project-URL: Documentation, https://github.com/infrastructurebuilder/cs-image-system-3/blob/develop/docs/OPERATIONS.md
+Project-URL: Package README, https://github.com/infrastructurebuilder/cs-image-system-3/blob/develop/packages/local-state-plugin/README.md
+Author-email: Mykel Alvis <mykelalvis@infrastructurebuilder.org>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.13
+Requires-Dist: cs-image-system-hashicorp-utils==0.1.1
+Requires-Dist: cs-image-system-system==0.1.1
+Requires-Dist: pydantic>=2.13
+Description-Content-Type: text/markdown
+
+# cs-image-system-local-state-plugin
+
+The `local` **state backend** plugin (stage 47): a state file on disk. It
+registers one model, `LocalStateBuilderModel`, for entries with `type:
+local` under `state_backends:` in `cfg/state-backends*.yml`. It is the type
+that needs nothing -- no bucket, no cloud, no credentials -- so a developer
+or a test can run a real `tofu init` against it, and it is what lets the
+frozen fixture exercise two backend types without a second cloud account.
+Like the S3 plugin it emits no files and runs no commands of its own: the
+terraform roots that bind to it get an empty `backend "local" {}` block, a
+partial configuration file carrying one setting, and consumers reading
+their state get a `terraform_remote_state` data source with the same
+setting.
+
+## What it registers
+
+```toml
+[project.entry-points."cs_image_system.plugins.state"]
+local_state_plugin = "cs_image_system.local_state_plugin.main:initialize"
+```
+
+| Service name (`type:` of a backend entry) | Model class | Builder class | Classifications (VCT) |
+|---|---|---|---|
+| `local` | `LocalStateBuilderModel` | `LocalStateBuilder` | `STATE_BACKEND_MODEL`, `STATE_BACKEND` |
+
+`initialize()` in [main.py](src/cs_image_system/local_state_plugin/main.py)
+returns a `LocalStateTypes` metadata object (plugin metadata version `1`,
+Python `3.13`). `LocalStateBuilder` in
+[local_state_builder.py](src/cs_image_system/local_state_plugin/local_state_builder.py)
+extends `StateBuilderBase` and implements no hooks: it generates nothing
+and defers nothing, and exists so the registry can pair the model with a
+builder class.
+
+## The model
+
+| Field | Type | Default | Meaning |
+|---|---|---|---|
+| common builder fields | | | `name` is what a root's `state_configuration` names; `is_default` marks the backend `default` resolves to |
+| `path` | str | `state` | a directory: relative to the configuration root, or absolute; one spelling per directory, so a `.` or `..` segment and a bare `/` are refused at load (stage 63) |
+| `executable` | str or null | null | the `cfg/executables.yml` entry the bound roots' tofu comes from; when declared it must exist there and is version-checked, when unset nothing is checked (stage 63; see "Configuration reference") |
+
+## The kind
+
+`LocalBackendKind` in
+[local_state_models.py](src/cs_image_system/local_state_plugin/local_state_models.py)
+renders the type for the collector (the contract the S3 plugin's README
+describes under "Adding a backend type"):
+
+| `location(settings, workspace)` | `backend_settings(...)` | `remote_state_settings(...)` |
+|---|---|---|
+| `local://<directory>/<super_safe_name(workspace)>.tfstate`, the directory normalised (repeated slashes collapsed, `./` and a trailing slash dropped, an absolute path kept); a `.` or `..` segment never reaches here, the model refuses it at load (stage 63) | `path = "<state path>"` | `path = "<state path>"` |
+
+The state path is the absolute directory as declared, or, for a relative
+one, the directory rewritten from the root directory's fixed depth:
+`../../../../<directory>/<workspace>.tfstate` (a root sits at
+`generated/<lifecycle>/<workspace>/<phase>/`, four below the configuration
+root). The emission therefore names no absolute path of the machine that
+generated it, and the same file works from a fresh clone.
+
+Two roots on one directory whose names collapse under `super_safe_name`
+would share a state file and are refused by the stage-46 collision check;
+the same name under `s3` and under `local` are two locations, not a
+collision. Because the model refuses a `.` or `..` segment at load (stage
+63), the directory the check compares is the directory's one spelling:
+`a/../b` can no longer pose as a second location beside `b` (until
+2026-09-25 it could, and the check saw two places where the disk had one).
+
+## Emission
+
+The frozen fixture binds its identity roots (`oktagroups`, `okta-tf-users`)
+to `local-dev` (`cfg/state-backends-3.yml`, `path: state`), so the golden
+carries
+[oktagroups-group-generation.tfbackend.hcl](../../tests/fixtures/v2_golden/generated/identity/oktagroups/group-generation/oktagroups-group-generation.tfbackend.hcl):
+
+```hcl
+# Backend 'local-dev' (local) partial configuration for workspace oktagroups
+path = "../../../../state/oktagroups.tfstate"
+```
+
+and, in every storage and instance root that reads the identity root's
+outputs, a `data "terraform_remote_state" "oktagroups"` with
+`backend = "local"` and `config = { path = "../../../../state/oktagroups.tfstate" }`
+-- a read across backend types, since those roots keep their own state in
+S3. The runner header lists `# state: workspace oktagroups ->
+local://state/oktagroups.tfstate`.
+
+## Example configuration
+
+```yaml
+---
+state_backends:
+  - name: local-dev
+    type: local
+    path: state
+```
+
+A root binds with `state_configuration: local-dev`. The live configuration
+keeps every root on its S3 backend by the standing decision; this type is
+for development, tests and configurations that have no cloud state.
+
+## Prerequisites and integration
+
+**Nothing beyond the core.** No account, no IAM role, no API, no
+credential and no network: the package's own test
+([test_local_backend.py](tests/test_local_backend.py)) runs a real
+`tofu init` and `tofu state pull` against the file the kind renders with an
+environment of `PATH`, `HOME` and `TF_IN_AUTOMATION` only, and asserts
+that no `AWS_*`, `GOOGLE_*` or `OKTA_*` variable is present. What the
+type does depend on is what the core already needs, and it is worth
+saying where each piece comes from.
+
+- **The package, installed.** The root
+  [pyproject.toml](../../pyproject.toml) lists
+  `cs-image-system-local-state-plugin` as a workspace member, so
+  `just init` installs it beside the others. The core finds it by the
+  entry point above: at every CLI start
+  [loader.py](../base/src/cs_image_system/base/loader.py) enumerates the
+  `cs_image_system.plugins.state` group and registers every service each
+  plugin returns. In an environment without this package no model is
+  registered under the type `local`, and a configuration whose entry says
+  `type: local` does not load.
+- **The gate.** The whole backend mechanism is behind
+  `config.use_state_backends` in `cfg/_config.yml`. Off, the entry is
+  loaded and registered but no root binds to it: no `backend "local" {}`
+  block, no `.tfbackend.hcl`, no remote-state data source, no
+  `# state:` header line, and no record in
+  `meta-state/state-locations.yaml`.
+  Off is itself refused by `validate` when any root would read another's
+  outputs through remote state (stage 63 item 19), so it is a shape only
+  for a tree where nothing reads anything.
+- **A tofu binary for the root, not for the backend.** The commands that
+  touch the state (`init`, `plan`, `apply`, `state pull`) are the ROOT's:
+  the identity, storage or instance builder's `executable:` names an
+  entry in `cfg/executables.yml`, and that binary is what runs (the
+  golden's identity runner calls `/usr/local/bin/tofu`). The backend
+  entry's own `executable` field does not pick the binary; since stage 63
+  it is a declaration that is CHECKED: when set it must name an entry of
+  `cfg/executables.yml` (so the tofu the roots on this backend run is
+  declared and version-checked like every other entry), and when unset --
+  the default now, where it used to default to `tofu` and be checked by
+  nothing until 2026-09-25 -- nothing is checked on the backend's behalf.
+  The `local` backend
+  is built into OpenTofu and Terraform: it downloads no provider and
+  needs no plugin cache entry. This plugin sets no version floor; the
+  `version` requirement declared on the root's executable in
+  `cfg/executables.yml` is what `validate` and every run check (stage 48).
+  OpenTofu 1.12.6 is what the package test and the probes recorded below
+  ran against.
+- **A directory the operator can write.** `path` names it, relative to
+  the configuration root (the directory that holds `cfg/`, `generated/`
+  and `meta-state/`) or absolute. It need not exist beforehand: tofu
+  creates the directory and the file at the first state write (probed
+  2026-09-23 with OpenTofu 1.12.6: `init` against a missing directory
+  succeeds, `state pull` answers empty, `apply` creates the directory
+  and writes `<workspace>.tfstate`). There is no lock service; tofu's
+  local backend locks the file itself for the duration of a command, and
+  the system runs one tofu process at a time.
+- **The state stays on the machine.** A local state file never travels
+  with the configuration repository: the live tree's `.gitignore` ignores
+  `*.tfstate`, the run's `--commit` stages only `meta-state/` and
+  `generated/` ([meta_state.py](../base/src/cs_image_system/base/meta_state.py),
+  `commit_meta_state`), and the public-safe rules refuse a `*.tfstate` at
+  any depth under those trees. So a fresh clone, a second machine and CI
+  hold NO state for a root bound to this type -- which is why the live
+  configuration keeps every root on S3, and why the consequences are
+  spelled out under "When it fails".
+- **The private mirror.** Since stage 49 a real run materialises a root
+  into `_private/<lifecycle>/<workspace>/<phase>/` and runs tofu there.
+  `mirror_path` in
+  [materialize.py](../base/src/cs_image_system/base/materialize.py) puts
+  `_private/` exactly where `generated/` stands, at the same depth, so
+  `../../../../<directory>/<workspace>.tfstate` counts up to the same
+  configuration root from either tree and one state file serves both. No
+  `_private/state/` is ever created.
+- **Reads across types.** A consumer root (an S3-bound storage or
+  instance root reading the identity root's outputs) gets a
+  `terraform_remote_state` data source with `backend = "local"` and the
+  same relative `path`. Terraform reads that file on the machine where the
+  consumer's plan runs: the producer's state must be present THERE.
+
+## Configuration reference
+
+The entry under `state_backends:` in `cfg/state-backends*.yml`. The model
+is a pydantic dataclass with `extra="forbid"`: an unknown key is refused at
+load, and a `parameters:` key is refused with a message naming
+`variables:` (stage 26). Inherited fields come from `NameTyped` and
+`BuilderModel` in
+[builder_model.py](../base/src/cs_image_system/base/models/builder_model.py);
+`StateBuilderModel` adds nothing but the classification, and a state
+backend has no `runtime` field.
+
+| Field | Type | Default | Meaning |
+|---|---|---|---|
+| `name` | str | required | The backend's name, normalised at load (lowercased, spaces and `:` to `_`); `/` and `\` are refused. This is the value a root's `state_configuration:` (or a runtime's) names; the collector looks the name up first and then the backends' `aliases` (stage 63). |
+| `type` | str | required | `local`. Selects this plugin at load and is the terraform backend type written into the consumers' `backend "local" {}` block and `backend = "local"` data sources. |
+| `path` | str | `state` | The directory the state files live in. Whitespace is stripped; empty or blank is refused at load. Relative means relative to the configuration root; absolute is kept as declared. Normalised for the location: repeated slashes collapsed, a leading `./` dropped, a trailing `/` dropped. No `~` or environment-variable expansion. Since stage 63 the normalised form may not contain a `.` or `..` segment (`a/../b`, `./x/./y`, `..`, `../state` are refused at load) and may not be the bare filesystem root `/`: one directory has one spelling. `path: .` (or `./`) alone is still accepted: it is the configuration root itself, one spelling of one directory. Until 2026-09-25 a `..` segment was kept as written (so `a/../b` and `b` were two locations to the collision check), and `path: /` rendered `//<workspace>.tfstate`. Each bound workspace gets `<path>/<super_safe_name(workspace)>.tfstate`. |
+| `is_default` | bool | `false` | Marks the backend that `state_configuration: default` (and an omitted field) resolves to. More than one default among the declared backends is refused when a root resolves it. |
+| `description` | str or null | null | Accepted, not read. |
+| `aliases` | set[str] | `{}` | Other names the backend answers to (stage 63). They travel on the `BackendRegistration`, and the collector's `resolve_backend` tries the backend names first and then every backend's aliases, so a root's (or runtime's) `state_configuration:` may name an alias and `validate` accepts the binding. Until 2026-09-25 aliases were registered and never read, and a binding to one was refused as not declared. The records (`# state:` header, `state-locations.yaml`) still name the backend by its `name`. |
+| `executable` | str or null | null | The `cfg/executables.yml` entry the tofu for the roots on this backend comes from (stage 63). Unset (the default): nothing is checked on the backend's behalf. Declared: `validate` and every run refuse a name that is not an entry of `cfg/executables.yml` (`check_state_backend_executables`), and the entry itself is version-checked like every executables entry (stage 48). The plugin still runs nothing under it, and the binary a root runs is still the root builder's own `executable`. Until 2026-09-25 the field defaulted to `tofu` and was checked by nothing. |
+| `config` | dict | `{}` | Accepted, not read. |
+| `gitignore` | list[str] | `[]` | Accepted, not read. |
+| `tags` | dict[str, str] | `{}` | Accepted, not read. |
+
+`path` is the only field the kind renders from: it is the one setting the
+registration carries (`settings={"path": ...}`). `aliases` travel beside it
+on the registration for the lookup, and `executable` is read by
+`validate`, not by the plugin.
+
+Fields outside this file that decide what the entry does:
+
+| Where | Field | Effect |
+|---|---|---|
+| `cfg/_config.yml` | `config.use_state_backends` | The gate. False: the entry is inert. |
+| a root's builder (group, user, storage, instance) | `state_configuration` | Names this backend, or `default`; the root's own value wins, else its runtime's, else the default (stage 46). |
+| a runtime builder | `state_configuration` | The second rung: every storage and instance root on that runtime inherits it unless the root names its own. The identity roots have no runtime and skip this rung. |
+
+See [docs/CONFIGURATION.md](../../docs/CONFIGURATION.md) section 10 for
+the chain and the collision rule in full.
+
+### Variations
+
+- **Relative vs absolute `path`.** When `path` is relative (`state`,
+  `state/dev`), the backend file and every data source carry
+  `../../../../<directory>/<workspace>.tfstate`, climbing four directories
+  from the phase directory to the configuration root, and the emission
+  names nothing of the generating machine. When `path` is absolute
+  (`/var/tf/state`), the file carries `/var/tf/state/<workspace>.tfstate`
+  verbatim: the emission then names a path that must exist on every
+  machine that runs the root, and a fresh clone elsewhere cannot use it
+  unchanged. The location record and the `# state:` header show the
+  declared directory in both cases (`local://state/...`,
+  `local:///var/tf/state/...`).
+- **`path: .`** (or `./`): the state files live in the configuration
+  root itself, and the backend file carries
+  `../../../../<workspace>.tfstate` with no directory segment. This is the
+  one place a `.` is accepted: stage 63 refuses a `.` or `..` segment
+  inside a longer path, not `.` alone.
+- **Named vs alias binding.** A root may name the backend by its `name`
+  or by any of its `aliases` (stage 63); both resolve to the same
+  registration and the same location, so switching a root from one
+  spelling to the other moves nothing.
+- **`executable` declared or not.** Unset, nothing about the backend is
+  version-checked. Declared (`executable: open-tofu-1`), the name must be
+  an entry of `cfg/executables.yml`, and that entry's version requirement
+  is checked by `validate` and at the head of every run (stage 63).
+- **Settings that were encrypted.** Any value may be an `ENC[age:...]`
+  marker. Since stage 63 the partial configuration file writes such a
+  setting as the ciphertext it was read from (`render_backend_value` in
+  the collector calls `emit`), and the execution's materialise step puts
+  the plaintext back in the `_private/` copy tofu runs from; until
+  2026-09-25 it was written in clear and only the plaintext guard caught
+  it. A `path` is not a secret, so for this type the rule is a
+  consistency guarantee rather than a practical option; the data source,
+  the `# state:` header and the location record are not part of that
+  change.
+- **Dry run vs real run.** A dry run (the default) initialises every root
+  with `init -backend=false`: providers are installed and the emission is
+  validated, but the backend file is not read, the state directory is not
+  created and no state file is touched. The frozen fixture's proof runs
+  are dry, which is why `tests/fixtures/config/` has no `state/`
+  directory. A real run (`--no-dry-run`) initialises with
+  `init -input=false -reconfigure -backend-config=<workspace>-<phase>.tfbackend.hcl`,
+  at generation time and again in the runner script before every plan,
+  and every plan and apply then reads and writes the file on disk.
+- **`use_state_backends` on vs off.** On, everything above. Off, the entry
+  is loaded and registered but no root is bound: no block, no file, no
+  data source, no header line, no location record, and the collision and
+  move checks skip (`check_state_locations` returns nothing when backends
+  are disabled).
+- **Named vs default vs inherited binding.** A root that names this
+  backend (`state_configuration: local-dev`) is bound to it whatever its
+  runtime says. A root at `default` on a runtime whose
+  `state_configuration` names a backend inherits THAT one. Only a root at
+  `default` with no runtime rung (the identity roots, or a runtime also
+  at `default`) takes the entry marked `is_default: true`.
+- **This type vs the object-store types.** The S3 and GCS kinds render a
+  bucket, a key or prefix and, for the backend file, encryption, locking
+  and identity settings; this kind renders one `path` in both the backend
+  file and the data source, and the stage-39 encryption rule
+  ([test_v2_state_encryption.py](../../tests/test_v2_state_encryption.py))
+  is scoped to `s3` and does not apply to it. A consumer in one type reads
+  a producer in another through a data source of the PRODUCER's type: an
+  S3-bound root reading a `local`-bound one emits
+  `backend = "local"` with a `path`, and the read happens on disk.
+- **`--migrate-state <root>` on a root bound to this type.** The move
+  operation (stage 46.4) is type-agnostic: `state-migration begin` writes
+  the previous location from `meta-state/state-locations.yaml` beside the
+  root as `<workspace>.tfbackend.previous.hcl`, initialises against the
+  new file and pulls; for a `local` new location that has no file yet
+  the pull answers empty and the location counts as empty, so the move
+  proceeds (`init -migrate-state -force-copy`, a plan that must be clean,
+  `state-migration finish`). A dry run refuses the flag outright.
+- **CI.** The CI recording job is dry, so it never initialises against
+  the file and never needs the directory; the `perform` job runs the live
+  tree, which binds no root to this type.
+
+## What it tests and verifies
+
+- **At load (pydantic, `__post_init__`).** `path` empty or whitespace is
+  refused; the value is stripped. The common checks apply: `name` with
+  `/` or `\` is refused, a name in the reserved set (`default`, `self`,
+  `none`, empty, null; refused where the file is read, naming it) is
+  refused, an unknown key is refused, `parameters` is refused.
+  Since stage 63, a `path` whose normalised form has a `.` or `..`
+  segment, or is the bare `/`, is refused too (messages under "When it
+  fails").
+  The verdict is a load error: the command that loaded the configuration
+  (`validate`, `run`, anything) stops before any check runs, with the
+  pydantic or `ValueError` message on stderr and exit 1.
+- **At `finalize()` (configuration load, before any generation phase).**
+  The model registers `BackendRegistration(name, "local", {"path": ...},
+  LOCAL_KIND, is_default, aliases)` with the run-wide `TerraformCollector`
+  (the aliases since stage 63). A
+  second registration under the same name with different settings is
+  refused (`HclConfigConflictError`); the same settings again are a
+  no-op.
+- **At `validate`, and at the head of every `run`
+  (`check_state_locations` in
+  [validate.py](../base/src/cs_image_system/base/commands/validate.py)).**
+  From the declarations alone, with nothing generated: every terraform
+  root's backend is resolved through the chain (by name, or by alias
+  since stage 63) and must be declared;
+  more than one `is_default` among the backends is refused; every root's
+  location is rendered by this kind (`local://<directory>/<workspace>.tfstate`)
+  and no two roots may share one; and a root whose resolved location
+  differs from the one `meta-state/state-locations.yaml` recorded is
+  refused while the records show live resources in it (a storage not
+  destroyed, a group or user the identity read-model attributes to it
+  after an executed identity run, an instance pinned to a build). A root
+  with nothing deployed moves with one INFO line. Verdicts are entries in
+  the validation error list: `validate` prints each and exits 1;
+  `run` records them in `generated/run-summary.json` under
+  `validation_errors`, generates nothing and exits 1.
+- **At `validate` and every run, the executables check
+  (`check_state_backend_executables`, stage 63).** A backend entry whose
+  `executable` is declared must name an entry of `cfg/executables.yml`;
+  that entry is version-checked with the others (stage 48). An unset
+  `executable` is skipped. Until 2026-09-25 the backend's `executable`
+  was not among the executables checked.
+- **At generation.** Each root binds itself with `set_backend`; a second
+  binding of one workspace to a different backend is refused
+  (`HclConfigConflictError`). Before the terraform block is rendered the
+  collector runs `validate_state_locations()` again over the bound
+  workspaces. The kind then renders the backend file, the data sources
+  and the `# state:` header, and the run records every bound workspace's
+  location in `meta-state/state-locations.yaml` as `backend`, `type`,
+  `location` and the file's `path` (a migrating root keeps its old record
+  until `finish`).
+- **At apply.** Nothing of the plugin's. Tofu's own `init` (real-run
+  form) validates the backend file and `plan`/`apply` read and write the
+  state file; their verdicts are tofu's exit codes in the runner, and
+  the run's `apply` status in `run-summary.json` and `meta-state/runs.yaml`.
+- **After apply (post-finalize hooks).** Nothing: the builder implements
+  no hooks.
+- **In the state query.** Nothing: this plugin contributes no provider
+  view, and the state file itself is never inspected by the system. The
+  only memory the system keeps of where the state is, is the location
+  record above.
+- **In the suite.** [test_local_backend.py](tests/test_local_backend.py)
+  pins the three renderings (relative, absolute, normalised spelling),
+  the collision rule across types, and a real `tofu init` plus
+  `state pull` with an empty environment (skipped when `tofu` is not on
+  the PATH). [tests/test_v2_state_locations.py](../../tests/test_v2_state_locations.py)
+  and [tests/test_v2_gate4_identity_storage.py](../../tests/test_v2_gate4_identity_storage.py)
+  pin the golden's record, header line and cross-type data source.
+
+## When it fails
+
+### Failures that have happened
+
+- **2026-09-19, the private mirror one level too deep.** Found by probing
+  an availability-zone change: `tofu init` in the materialised copy
+  could not read its module, because the mirror stood one directory
+  deeper than the root it mirrored. Every relative path in an emission counts
+  directories up to the configuration root, and this type's
+  `../../../../<directory>/<workspace>.tfstate` is one of them: from the
+  deeper mirror it would have named a directory that does not exist
+  (or, worse, a different `state/` under `_private/`) and a real run
+  would have planned against an empty state. The fix in
+  [materialize.py](../base/src/cs_image_system/base/materialize.py)
+  (`mirror_path`) replaces the generation directory's name with
+  `_private` instead of nesting under it, and its docstring names this
+  type. What to look for if it recurs: an `init` or `plan` in
+  `_private/...` that fails to find a module source or reports an empty
+  state while `generated/...` on the same machine has it; compare the
+  depth of the two directories.
+
+### Failures the code raises
+
+- `Terraform state backend 'path' cannot be empty for 'local' type.` --
+  at load, `path: ""` or `path: "   "`. Give the entry a directory or
+  delete the key (the default is `state`).
+- ``state backend '<name>': `path: <path>` has a `.` or `..` segment;
+  write the directory once, without them`` -- at load (stage 63), a
+  `path` such as `a/../b`, `./x/./y`, `..` or `../state` (`.` alone is accepted). Write the
+  directory the way it is meant (`b`, `x/y`), or give an absolute path
+  for a directory outside the configuration root. Until 2026-09-25 such a
+  path was accepted and `a/../b` was a different location from `b` to the
+  collision check.
+- ``state backend '<name>': `path: /` would put state files in the
+  filesystem root; name a directory`` -- at load (stage 63), `path: /` (or
+  `//`). Until 2026-09-25 it rendered `//<workspace>.tfstate`. Name a real
+  directory.
+- `Executable <x> specified for state backend <name> not found in
+  executables list.` -- at `validate`/`run` (stage 63), the entry's
+  `executable` names nothing in `cfg/executables.yml`. Fix the spelling,
+  declare the entry, or remove the key (unset means unchecked).
+- `Name '<name>' contains invalid characters: {'/', '\\'}` -- at load, a
+  backend name with a slash. Name it without one; the directory belongs
+  in `path`.
+- A pydantic "extra inputs are not permitted" error naming the key -- at
+  load, a key the model does not have (a `bucket:` or `key:` copied from
+  an S3 entry, a typo). The only own field is `path`.
+- A message saying `parameters` was retired (stage 26) and naming
+  `variables:` -- at load; delete the key.
+- `State backend '<name>' registered twice with different configurations`
+  -- at load (`finalize`), two entries with one name across the
+  `state-backends*.yml` files. Rename one.
+- `workspace '<ws>' names state backend '<name>', which is not declared`
+  -- at `validate`/`run`, a root's (or its runtime's) `state_configuration`
+  names something no entry is registered under, by name or by alias.
+  Check the spelling against the entry's `name` and `aliases` (an alias
+  resolves since stage 63; until 2026-09-25 it was refused here).
+- `Multiple default state backends registered: [...]` -- at
+  `validate`/`run` when a root resolves `default` and more than one entry
+  says `is_default: true`. Leave one.
+- `state location collision: workspaces <a>, <b> would share the state
+  object local://<directory>/<name>.tfstate` -- at `validate`/`run`: two
+  roots on one directory whose names collapse under `super_safe_name`
+  (`ws-local` and `ws_local`), or two backend entries that normalise to
+  one directory (`state` and `./state//`). Rename a root or separate the
+  directories. The check compares the normalised directory; since stage
+  63 a `.` or `..` segment is refused at load, so `a/../b` can no longer
+  slip past as a second spelling of `b` (it could until 2026-09-25). An
+  absolute path is still never matched against the relative spelling of
+  the same directory.
+- `Workspace '<ws>' is bound to state backend '<x>' and cannot be rebound
+  to '<y>'` -- at generation, a builder trying to bind one workspace to
+  two backends; not reachable from configuration alone.
+- `workspace '<ws>' would move its state from local://... to <new> while
+  <what stands> stand(s) in it: the new location is empty, so the next
+  plan would create everything again and strand the old state. To MOVE
+  the state: `run --no-dry-run ... --migrate-state <ws>` ...` -- at
+  `validate`/`run`, after a root bound to this type is rebound (to S3, or
+  to another directory) while its records show live resources. Either
+  run the migration, or correct the records if the resources are gone;
+  never edit the record to get past it.
+- `--migrate-state moves state and needs --no-dry-run: a dry run never
+  moves state` -- on stderr, exit 2, before the configuration loads.
+- `state-migration begin: the new location local://... already holds
+  state (lineage ...) that is not this workspace's: a collision, refused.
+  The old state is untouched.` -- in the runner of a migrating root, when
+  a file already exists at the new path from another lineage. Move or
+  remove that file by hand after checking whose it is.
+- `State backend '<name>' (type 'local') was registered without a kind`
+  -- cannot occur through this model, which always supplies `LOCAL_KIND`;
+  it is the collector's guard for a hand-built registration.
+
+### Failures tofu raises that this type invites
+
+The system never inspects the state file, so these surface from tofu in
+the runner (a non-zero exit stops the runner at that root; the run
+records the lifecycle's apply as `failed`).
+
+- **A plan that creates everything again, on a machine that has no state
+  file.** The state stays on the machine that applied (see
+  "Prerequisites"), so a real run of a `local`-bound root from a fresh
+  clone, another machine or CI finds an empty location and the plan
+  proposes every resource anew. Nothing in the system refuses this: the
+  location record matches (same `local://...`), so the move guard is
+  silent; only the plan's size and the `gate-plan` step (which refuses
+  destroys, not creates) stand between the operator and a duplicate
+  deployment. Where to look: `<workspace>.tfstate` under the declared
+  directory on the machine that last applied; the `# state:` header of
+  the runner script names the directory. What to do: copy the file, or
+  bind the root to an S3 backend and migrate. This is the reason the
+  live configuration keeps every root on S3.
+- `Error: Unable to find remote state` / `No stored state was found for
+  the given workspace in the given backend.` -- from `plan` in a CONSUMER
+  root (an S3-bound storage or instance root reading a `local`-bound
+  producer through its `terraform_remote_state` data source) when the
+  producer's file is absent on the machine running the plan (probed
+  2026-09-23 with OpenTofu 1.12.6). The producer root has never been
+  applied here, or was applied elsewhere. Apply the producer first, on
+  this machine, or bring its state file.
+- `Backend configuration changed` -- would follow from a changed `path`
+  on a root initialised against the old one, but every init the system
+  emits carries `-reconfigure`, so it does not occur under the system's
+  own commands; a hand-run `tofu init` without the flag can hit it.
+- A permission error from `apply` or `state push` writing under `path` --
+  the directory (or a parent tofu must create) is not writable by the
+  operator. Fix the directory; nothing in the system pre-checks it.
+
+## Related
+
+- [tf-s3-state-plugin](../tf-s3-state-plugin/README.md): the S3 type, and
+  the recipe for adding a type.
+- [hashicorp-utils](../hashicorp-utils/README.md): the collector and the
+  `BackendRegistration` / `StateLocation` contract.
+- [docs/CONFIGURATION.md](../../docs/CONFIGURATION.md) section 10 and
+  [docs/OPERATIONS.md](../../docs/OPERATIONS.md) "Where state lives".

cs_image_system_local_state_plugin-0.1.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+cs_image_system/local_state_plugin/__init__.py,sha256=GAFRNaGWQxXquHOlCzxan4LkPZ9_NsiyswknxdPcX0c,122
+cs_image_system/local_state_plugin/local_state_builder.py,sha256=WWZrCcN87lZbcbIOC0nmoGaMO2IdBE8mKcveBQ3RWwo,608
+cs_image_system/local_state_plugin/local_state_models.py,sha256=_HA1kD0-zzbea0cPUSn7PtFuYsqN9cNLb4lbi3x1L0Q,5730
+cs_image_system/local_state_plugin/main.py,sha256=SeJW6NiDGdcyEXvy3g9QnI1XJF6IQ-5eNfDiG5QNedw,861
+cs_image_system_local_state_plugin-0.1.1.dist-info/METADATA,sha256=QBkXKMcHMoetMH7DQ0mXMm1rY8R-PaST0RA_BxDm7tk,32549
+cs_image_system_local_state_plugin-0.1.1.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+cs_image_system_local_state_plugin-0.1.1.dist-info/entry_points.txt,sha256=iufMtMkKJNdEDkeZrzTex8YV8-7x3LgCPXcNqmJD6cU,104
+cs_image_system_local_state_plugin-0.1.1.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+cs_image_system_local_state_plugin-0.1.1.dist-info/RECORD,,

cs_image_system_local_state_plugin-0.1.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

cs_image_system_local_state_plugin-0.1.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[cs_image_system.plugins.state]
+local_state_plugin = cs_image_system.local_state_plugin.main:initialize

cs_image_system_local_state_plugin-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.