@alma-harness/testing 0.1.0

package/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.

package/README.md

@@ -0,0 +1,53 @@
+# @alma-harness/testing
+
+The shared storage contract suites of [Alma](https://github.com/FabioFernandesCarneiro/alma)
+— what "correct" means for every storage adapter, on any backend.
+
+> **Status: pre-release.** Not yet published to npm.
+
+## What it owns
+
+- `describeSessionStoreContract` — the `SessionStore` contract.
+- `describeEpisodeStoreContract`, `describeProfileStoreContract` — the memory
+  storage contracts: deterministic ids, three states never conflated, the
+  three-case confidence rule, identity never extracted, a budget on every read.
+- `describeMemoryErasureContract` — the LGPD/GDPR story as a test: content
+  gone, derived data invalidated, every declared copy surface reached.
+- `describeSpendStoreContract` — the `SpendStore` contract (spec: spend-store):
+  atomic increment-and-return, UTC day bucketing, org-wide day aggregation,
+  no lost increments under concurrency.
+- `describeTurnStoreContract` — the `TurnStore` contract (spec 030): exactly one
+  winner per session, leases that expire so a crashed holder never blocks
+  forever, a stale release that touches nothing, claims that replay a finished
+  turn, and erasure that reaches the stored reply.
+- The proof tests that run each suite against the reference implementations
+  (`@alma-harness/core/testing` for sessions, `@alma-harness/memory/testing`
+  for memory) — which is what proves the contracts are satisfiable at all.
+
+Backend neutrality is enforced by running one suite against every backend —
+the reason `pnpm check:all` refuses to pass with no `DATABASE_URL` rather than
+letting these suites skip themselves (spec 031). From an adapter's test file:
+
+```ts
+import { describeEpisodeStoreContract } from "@alma-harness/testing";
+
+describeEpisodeStoreContract("MyEpisodeStore", { create: () => new MyEpisodeStore() });
+```
+
+Requires vitest (peer dependency): a contract suite IS a set of tests.
+
+## What it must never do
+
+- Weaken a suite for one backend's convenience — a backend idiom that cannot
+  pass the shared contract is a bug in the adapter, not in the contract.
+- Grow assertions an adapter can satisfy by convention only: every normative
+  rule of the memory charter is pinned here, or it is not a rule.
+- Ship in a runtime dependency graph. This package is a devDependency of
+  adapters, never a dependency of products.
+
+## Documentation
+
+[Docs index](../../docs/README.md) · [Architecture](../../docs/architecture.md)
+· [Invariants](../../docs/invariants.md)
+
+Apache-2.0

package/dist/index.d.ts

@@ -0,0 +1,125 @@
+import { SessionStore, EpisodeStore, ProfileStore, MemoryErasure, ErasureWatermarkStore, AccessEvent, SpendStore, TurnStore } from '@alma-harness/core';
+
+/**
+ * Shared `SessionStore` contract suite — §6: storage contracts are
+ * backend-neutral by construction; every adapter (in-memory, Postgres,
+ * Firestore emulator) runs this exact suite in CI, so no backend idiom
+ * fossilizes into the contract.
+ *
+ * Usage, from an adapter's test file:
+ *
+ * ```ts
+ * import { describeSessionStoreContract } from "@alma-harness/testing";
+ *
+ * describeSessionStoreContract("PostgresSessionStore", {
+ *   create: () => makeStoreOnFreshSchema(),
+ *   destroy: (store) => dropSchema(store),
+ * });
+ * ```
+ */
+interface SessionStoreFactory {
+    /** Must return a store with NO data visible to the scopes used by the suite. */
+    create(): Promise<SessionStore> | SessionStore;
+    /** Optional teardown, called after each test. */
+    destroy?(store: SessionStore): Promise<void> | void;
+}
+declare function describeSessionStoreContract(name: string, factory: SessionStoreFactory): void;
+
+/**
+ * Shared `EpisodeStore` contract suite — §6, spec 011. Every adapter
+ * (in-memory, Postgres, Firestore emulator) runs this exact suite in CI, so no
+ * backend idiom fossilizes into the contract and the normative rules of spec
+ * 010 hold everywhere: deterministic ids, three states never conflated,
+ * budget at the reader, declared copy surfaces.
+ *
+ * ```ts
+ * describeEpisodeStoreContract("PostgresEpisodeStore", { create: () => … });
+ * ```
+ */
+interface EpisodeStoreFactory {
+    /** Must return a store with NO data visible to the scopes used by the suite. */
+    create(): Promise<EpisodeStore> | EpisodeStore;
+    destroy?(store: EpisodeStore): Promise<void> | void;
+}
+declare function describeEpisodeStoreContract(name: string, factory: EpisodeStoreFactory): void;
+
+/**
+ * Shared `ProfileStore` contract suite — §6, spec 011. Pins the normative
+ * rules of spec 010 that no adapter may reinterpret: identity is never
+ * extracted, terminal states are create-only, the three-case confidence rule,
+ * derived invalidation via provenance, and a budget on every read.
+ */
+interface ProfileStoreFactory {
+    create(): Promise<ProfileStore> | ProfileStore;
+    destroy?(store: ProfileStore): Promise<void> | void;
+}
+declare function describeProfileStoreContract(name: string, factory: ProfileStoreFactory): void;
+
+/**
+ * Shared `MemoryErasure` contract suite — §6.7, §10, spec 011.
+ *
+ * The caller supplies the wired implementation (the orchestrator from
+ * `@alma-harness/memory` over its own stores) plus the stores themselves, so
+ * the suite can arrange data and verify the outcome through the same seams a
+ * product would use. This is the LGPD/GDPR story as a test: content gone,
+ * derived data invalidated, every declared copy surface reached.
+ */
+interface MemoryErasureFactory {
+    create(): Promise<MemoryErasureFixture> | MemoryErasureFixture;
+    destroy?(fixture: MemoryErasureFixture): Promise<void> | void;
+}
+interface MemoryErasureFixture {
+    erasure: MemoryErasure;
+    episodes: EpisodeStore;
+    profile: ProfileStore;
+    watermarks?: ErasureWatermarkStore;
+    /** Events the wired `AuditLog` received — the erasure trail (§6.8, §10). */
+    accessEvents?: readonly AccessEvent[];
+}
+declare function describeMemoryErasureContract(name: string, factory: MemoryErasureFactory): void;
+
+/**
+ * Shared `SpendStore` contract suite — spec: spend-store. Pins what budget
+ * enforcement is entitled to rely on, on any backend: atomic
+ * increment-and-return, UTC day bucketing, session isolation by full scope,
+ * org-wide day aggregation, and no lost increments under concurrency.
+ *
+ * Deliberately absent: any erasure surface. Spend counters are content-free
+ * aggregates retained through scoped purge (spec: spend-store) — a store that
+ * grows one is offering a budget reset, not a feature.
+ *
+ * ```ts
+ * describeSpendStoreContract("PostgresSpendStore", { create: () => … });
+ * ```
+ */
+interface SpendStoreFactory {
+    /** Must return a store with ZERO totals for the scopes used by the suite. */
+    create(): Promise<SpendStore> | SpendStore;
+    destroy?(store: SpendStore): Promise<void> | void;
+}
+declare function describeSpendStoreContract(name: string, factory: SpendStoreFactory): void;
+
+/**
+ * Shared `TurnStore` contract suite — spec 030. Pins what the loop's turn
+ * coordination is entitled to rely on, on any backend: exactly one winner per
+ * session, a lease that expires so a crashed holder never blocks forever, a
+ * stale release that touches nothing, a claim that replays a finished turn,
+ * and erasure that reaches the stored reply.
+ *
+ * Timing is exercised with REAL time and small TTLs, deliberately. A fake
+ * clock cannot reach a Postgres `now()`, and one that desynchronizes from the
+ * `setTimeout` a wait is built on makes the reference store and the adapter
+ * prove different things.
+ *
+ * ```ts
+ * describeTurnStoreContract("PostgresTurnStore", { create: () => … });
+ * ```
+ */
+interface TurnStoreFactory {
+    /** Must return a store holding NO leases or claims for the scopes below. */
+    create(): Promise<TurnStore> | TurnStore;
+    destroy?(store: TurnStore): Promise<void> | void;
+}
+declare function describeTurnStoreContract(name: string, factory: TurnStoreFactory): void;
+
+export { type EpisodeStoreFactory, type MemoryErasureFactory, type MemoryErasureFixture, type ProfileStoreFactory, type SessionStoreFactory, type SpendStoreFactory, type TurnStoreFactory, describeEpisodeStoreContract, describeMemoryErasureContract, describeProfileStoreContract, describeSessionStoreContract, describeSpendStoreContract, describeTurnStoreContract };