Metadata-Version: 2.4
Name: SpecGo
Version: 1.0.1
Summary: CLI-first spec-to-API agent for embedded protocols.
Author: Ce Xu
Author-email: Ce Xu <dylanalexxc@gmail.com>
License:                                  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.
        
Project-URL: Homepage, https://github.com/specgo-dev/SpecGo
Keywords: embedded,protocol,can,dbc,codegen,code-generation,validation,testing,property-testing,toolchain
Platform: Windows
Platform: Linux
Platform: macOS
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Software Development :: Code Generators
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: System :: Hardware :: Hardware Drivers
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer>=0.12.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: pydantic>=2.0
Requires-Dist: cantools>=39.0
Requires-Dist: jinja2>=3.1.2
Dynamic: author
Dynamic: license-file
Dynamic: platform
Dynamic: requires-python

# SpecGo

**Spec → IR → Codegen → Gate → Test → Report**

SpecGo is a CLI-first toolchain that turns embedded communication protocol specifications (CAN DBC) into a unified **Spec IR**, generates verified protocol encoder/decoder code (C), and validates every artifact through deterministic **quality gates** and **seeded property tests**.

## Why SpecGo?

Protocol implementations (encoder/decoder, bit packing, endianness) are error-prone and hard to verify against the original specification. Code generation without a verification loop just produces bugs faster.

**Core principle:** Generate + Gate + Verify — every artifact must pass through deterministic gates before it counts as "done".

## Architecture

```
┌──────────────┐     ┌──────────┐     ┌──────────┐     ┌───────────┐     ┌──────────┐
│  Spec Files  │────▶│  Ingest  │────▶│  Spec IR │────▶│  Codegen  │────▶│  Output  │
│    .dbc      │     │ cantools │     │  (.yaml) │     │ (Jinja2)  │     │  .c / .h │
└──────────────┘     └──────────┘     └────┬─────┘     └───────────┘     └────┬─────┘
                                           │                                  │
                                     ┌─────▼──────┐                     ┌─────▼─────┐
                                     │ Validator  │                     │   Gates   │
                                     │ L0 Schema  │                     │ Codegen + │
                                     │ L1 Semantic│                     │ Roundtrip │
                                     └────────────┘                     └───────────┘
```

**IR is the center** — the spec is first converted into a structured, versionable, diffable IR. All downstream steps operate on IR.

**Validation first** — Pydantic schema validation is the entry point. Semantic checks cover DLC bounds, bit overlap, endianness layout, enum range, and scale correctness.

**Gates are mandatory** — codegen artifacts are gated (deterministic hash, file presence, compile syntax), then verified by seeded roundtrip property tests.

## Current Status

| Component | Status |
|-----------|--------|
| DBC → IR ingestion (`cantools`) | Done |
| IR model (Pydantic v2) | Done |
| Layer 0: Schema validation | Done |
| Layer 1: Semantic validation (DLC, bit overlap, enum, scale, endianness) | Done |
| Protocol codegen (Jinja2, C encode/decode) | Done |
| Codegen gate (deterministic hash, file presence, compile syntax) | Done |
| Seeded roundtrip property tests (encode/decode verification) | Done |
| CLI commands (`ingest`, `validate`, `proto-codegen`, `gate-codegen`, `test-roundtrip`, `start`, `config`) | Done |
| Workspace bootstrap & config management (global + project scope) | Done |
| Cross-platform compilation (GCC/Clang + MSVC) | Done |
| YAML report generation (summary + error reports) | Done |
| PDF / Text ingest | Planned |
| Multi-language codegen (C++, Python, Rust) | Planned |
| API wrapper / platform adapter codegen | Planned |
| Agent pipeline orchestration (LLM-assisted) | Planned |
| Differential testing (`test-diff`) | Planned |

## Update Log

### v1.0.1 (2026-03-12) - First Stable Release

- First public stable release of SpecGo.
- End-to-end deterministic pipeline available: `ing` -> `val` -> `gen` -> `gate` -> `rt`.
- DBC ingest, IR schema/semantic validation, C protocol codegen, and codegen gates are production-ready.
- Seeded raw roundtrip property testing and YAML report output are included by default.
- Workspace bootstrap (`start`) and scoped config (`config`, `-g config`) are available.
- LLM/Agent config fields are reserved for future integration; advanced LLM-assisted flow is still planned.

## Quickstart

```bash
pip install -e .
specgo start
specgo --help
```

## Recommended Command Flow (Ordered)

Use this sequence for a deterministic pipeline from spec to verified artifacts.

### 1) Initialize workspace/config

```bash
# initialize global + project workspace metadata
specgo start
```

### 2) Ingest spec file to IR

```bash
# input: your .dbc
# output: specgo_output/output/<name>.ir.yaml
specgo ing path/to/your.dbc -f
```

### 3) Validate IR (Layer 0 + Layer 1)

```bash
# output: <ir>.validation.yaml
specgo val specgo_output/output/your.ir.yaml
```

### 4) Generate protocol C/H

```bash
# output: specgo_output/gen/<name>_protocol.c/.h
specgo gen specgo_output/output/your.ir.yaml
```

### 5) Run codegen gate (determinism + file checks + compile syntax)

```bash
specgo gate specgo_output/output/your.ir.yaml
```

### 6) Run seeded roundtrip tests (raw encode/decode checks)

```bash
# default: loops=10, continue-on-fail
# reports: specgo_output/raw_reports/
specgo rt -n 10
```

### 7) (Planned) Differential test for wrapper/AI-augmented layers

```bash
# reserved for future wrapper-vs-baseline behavior comparison
specgo diff
```

Recommended order summary: `start` → `ing` → `val` → `gen` → `gate` → `rt` → `diff(planned)`

## Verifiable Templates

The `examples/` folder provides sanitized verification templates for quick checks.

### 1) Valid DBC (ingest + validate should pass)

```bash
specgo ing examples/template_valid_sanitized.dbc -f
specgo val specgo_output/output/template_valid_sanitized.ir.yaml
```

### 2) Semantic-fail DBC (validate should fail by design)

```bash
specgo ing examples/template_invalid_semantic_sanitized.dbc -f
specgo val specgo_output/output/template_invalid_semantic_sanitized.ir.yaml
```

Expected failure reason: Layer-1 semantic check reports `scale is 0`.

### 3) Roundtrip mismatch demo (encode/decode intentionally inconsistent)

```bash
specgo ing examples/template_roundtrip_mismatch_sanitized.dbc -f
specgo val specgo_output/output/template_roundtrip_mismatch_sanitized.ir.yaml
specgo rt \
  --ir-glob specgo_output/output/template_roundtrip_mismatch_sanitized.ir.yaml \
  --artifact-dir examples/roundtrip_mismatch_artifacts \
  -n 1 -c 2 --stop-on-fail
```

Expected result: roundtrip run exits with `FAILED` and writes error reports.

Note: generated reports may contain local absolute paths; keep runtime outputs out of git.

## CLI Commands

| Command | Description |
|---------|-------------|
| `specgo ingest` / `specgo ing` | Parse DBC file and emit IR YAML (`specgo_output/output` by default) |
| `specgo validate` / `specgo val` | Run Layer 0 + Layer 1 validation, emit `.ir.validation.yaml` |
| `specgo proto-codegen` / `specgo gen` | Generate C protocol encoder/decoder from IR |
| `specgo gate-codegen` / `specgo gate` | Verify codegen artifacts (hash, presence, compile) |
| `specgo test-roundtrip` / `specgo rt` | Run seeded roundtrip property tests on generated code |
| `specgo test-diff` / `specgo diff` | Differential test entry (planned) |
| `specgo start` / `specgo init` | Discover project root and initialize workspace/bootstrap metadata |
| `specgo config` / `specgo cfg` / `specgo -g config` | Show or update project/global config |
| `specgo run` / `specgo go` | Full agent pipeline (planned) |

Default output paths (when no custom paths are given):

| Path | Content |
|------|---------|
| `specgo_output/output/` | Imported IR YAML files |
| `specgo_output/gen/` | Generated C/H artifacts |
| `specgo_output/raw_reports/` | Roundtrip test reports |
| `specgo_output/reports/` | Diff-test outputs (planned) |

## Workspace & Config

`specgo start` bootstraps the workspace:
- Auto-scans upward for project root (`.git`)
- Creates global config at `~/.specgo/config` (first-time interactive dialog)
- Creates project workspace at `<project>/.specgo/` with `config` and `run` metadata files

`specgo config` manages configuration:
- Project scope (default): reads/writes `<project>/.specgo/config`
- Global scope (`-g`): reads/writes `~/.specgo/config`
- Set values: `--set key=value` (supports dotted keys like `llm.provider=openai`)
- Workspace directory name is locked to `.specgo`

Note: LLM/Agent fields shown during `specgo start` initialization are placeholders for future integration and are not functionally wired yet.

## Pipeline: Gate → Test Responsibilities

- **`gate-codegen`** — artifact gate for protocol codegen output (`.h/.c`):
  - Deterministic generation check (re-generate and compare hashes)
  - Expected file presence validation
  - Compile syntax gate (GCC/Clang on Linux/macOS, MSVC on Windows)

- **`test-roundtrip`** — seeded randomized property tests for `encode`/`decode`:
  - Verifies every generated protocol function against IR signal semantics
  - Encode → decode roundtrip: `decode(encode(struct)) == struct`
  - Decode → encode masked payload: occupied bits preserved, unoccupied bits zeroed
  - Can run directly on already-gated artifacts via `--artifact-dir`
  - Reports persisted as YAML with full reproducibility info

Recommended order: `val` → `gen` → `gate` → `rt`

## Roundtrip Testing

Reports:

- Summary: `<timestamp>-raw.report.yaml` (always emitted)
- Errors: `<timestamp>-raw.error.report.yaml` (on failures)
- Default location: `specgo_output/raw_reports/`
- `master_seed` and `loop_seeds` always persisted for exact reproduction
- `--continue-on-fail` (default) / `--stop-on-fail` for fail-fast

## Spec IR Model

Pydantic v2 model serialized to YAML:

```yaml
ir_version: '0.1'
meta:
  name: FILE_NAME
  version: unknown
  source: DIR/FILE_NAME.dbc
  format: dbc
bus_type:
  bustype: CAN
  busmode: classic
messages:
  - id: 34
    name: XXXXMSG
    dlc: 8
    signals:
      - name: XXXXXXError
        start_bit: 0
        bit_length: 1
        byte_order: little_endian
        signed: false
        scale: 1.0
        offset: 0.0
        enum:
          - name: "No Fault"
            value: 0
          - name: "Fault Present"
            value: 1
```

## Validation Layers

- **Layer 0 (Schema):** Pydantic model validation — types, required fields, constraints
- **Layer 1 (Semantic):**
  - Signal bits fit within message DLC (little-endian and big-endian/Motorola)
  - No overlapping signal bit ranges
  - Default values within [min, max]
  - Enum values fit within bit_length (signed/unsigned aware)
  - Scale is not zero
  - min < max when both are set

## Known Limitations

- Enum metadata exists in IR but is not emitted as C `enum`/constants in generated code.
- Signal storage is fixed to 64-bit integer types (`uint64_t` / `int64_t`).
- Generated code encodes/decodes **raw** signal values only (scale/offset preserved as metadata comments, physical-value conversion not yet implemented).

## Project Structure

```
specgo/
├── cli/                         # Typer CLI
│   ├── main.py                  # App entry point, global flags
│   ├── default_paths.py         # Shared default output paths
│   └── commands/
│       ├── start.py             #   specgo start / init
│       ├── config.py            #   specgo config / cfg
│       ├── spec_ingest.py       #   specgo ingest / ing
│       ├── spec_validate.py     #   specgo validate / val
│       ├── codegen_protocol.py  #   specgo proto-codegen / gen
│       ├── gate_codegen.py      #   specgo gate-codegen / gate
│       ├── test_roundtrip.py    #   specgo test-roundtrip / rt
│       ├── test_diff.py         #   specgo test-diff / diff (planned)
│       └── run.py               #   specgo run / go (planned)
├── ir/                          # Intermediate Representation
│   ├── model.py                 # SpecIR / Message / Signal (Pydantic v2)
│   ├── io.py                    # YAML I/O, path validation utilities
│   └── validator/
│       ├── layer0_schema.py     #   Pydantic schema check
│       └── layer1_semantic.py   #   Semantic cross-field checks
├── ingest/                      # Spec file converters
│   ├── dispatcher.py            # Route by file extension
│   └── dbc.py                   # DBC → IR (via cantools)
├── codegen/                     # Code generation
│   ├── protocol.py              # Protocol encoder/decoder codegen
│   ├── naming.py                # C identifier / symbol naming policy
│   ├── render.py                # Jinja2 template rendering
│   └── templates/c/
│       ├── protocol.h.j2        #   Header (structs, prototypes, macros)
│       └── protocol.c.j2        #   Source (bit-level encode/decode)
├── gates/                       # Quality gate evaluation
│   ├── codegen.py               # Codegen artifact gates (hash, compile)
│   ├── evaluator.py             # Gate threshold evaluation
│   ├── metrics.py               # Gate metrics models
│   └── io.py                    # Gate I/O helpers
├── testgen/                     # Test generation & execution
│   ├── property.py              # Signal bit helpers, random value gen
│   ├── raw/
│   │   ├── runner.py            #   Campaign runner (compile, test, report)
│   │   └── io.py                #   Report I/O
│   └── tests/
│       └── test_roundtrip_property.py
└── workspace/                   # Workspace & config management
    ├── bootstrap.py             # Project/global workspace bootstrap
    └── config_model.py          # Pydantic config models (Global, Project, RunState)
```

## Dependencies

- Python >= 3.11
- [Pydantic](https://docs.pydantic.dev/) >= 2.0 — IR model & validation
- [cantools](https://github.com/cantools/cantools) >= 39.0 — DBC parsing
- [Typer](https://typer.tiangolo.com/) >= 0.12 — CLI framework
- [PyYAML](https://pyyaml.org/) >= 6.0 — IR serialization
- [Jinja2](https://jinja.palletsprojects.com/) >= 3.1.2 — Code generation templates
- C compiler (GCC/Clang or MSVC) — required for gate-codegen and test-roundtrip

## License

Apache-2.0. See [LICENSE](LICENSE).
