davide.trentin/nc_program_manager
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
nc_program_manager/.paul/ROADMAP.md
dtrentin 4cd7715594 fix(robustness): null guard WMI reads, dispose SHA256, abort LSV2 timeout (ISS-001, ISS-005, ISS-006) 
ISS-001: MachineFingerprint.GetFingerprint() — null-safe WMI property reads
  - processorID and SerialNumber accessed with ?. and ?? string.Empty
  - prevents NullReferenceException on machines with missing WMI properties

ISS-005: LicenseValidator.Validate() — SHA256CryptoServiceProvider in using block
  - disposed on all code paths (success and failure)

ISS-006: Lsv2Client.Connect() — close TcpClient on timeout
  - _tcp.Close() called when ConnectAsync.Wait() times out
  - aborts pending socket task instead of leaking thread-pool slot

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-18 23:00:08 +02:00

184 lines
6.6 KiB
Markdown
Raw Blame History

# Roadmap: FanucProgramManager
## Overview
Console tool for CNC program transfer and file management. Fanuc FOCAS base, expanding to multi-CN (Heidenhain LSV2, Siemens FTP, Mitsubishi FTP) with NC program validation.
## Current Milestone
**v0.1 Multi-CN Release** (v0.1.0)
Status: ✅ Complete
Phases: 5 of 5 complete
Completed: 2026-05-13
## Phases
| Phase | Name | Plans | Status | Completed |
|-------|------|-------|--------|-----------|
| 1 | cnc-abstraction | 1 | ✅ Complete | 2026-05-13 |
| 2 | heidenhain | 1 | ✅ Complete | 2026-05-13 |
| 3 | siemens | 1 | ✅ Complete | 2026-05-13 |
| 4 | program-wiring | 1 | ✅ Complete | 2026-05-13 |
| 5 | nc-validator | 1 | ✅ Complete | 2026-05-13 |
## Phase Details
### Phase 1: cnc-abstraction ✅
**Goal:** Fix namespace, add all Cnc/ files to csproj, complete ICncMachine + IFanucMachine with 3-file support
**Completed:** 2026-05-13
**Delivered:**
- Namespace `Fanuc_integration.Cnc.*` → `FanucProgramManager.Cnc.*` (29 files)
- `IFocasDialect` extended: `UploadStart`/`DownloadStart` accept `short fileType`
- `IFanucMachine` interface: extends `ICncMachine` with tool offset + work zero R/W
- `CncManufacturer` enum: Fanuc, Heidenhain, Siemens
- All 29 `Cnc/**/*.cs` files added to csproj
### Phase 2: heidenhain ✅
**Goal:** Implement ICncMachine for Heidenhain TNC via LSV2 protocol
**Completed:** 2026-05-13
**Delivered:**
- `HeidenhainConnectionConfig` — IP, port 19000, credentials, timeout
- `Lsv2Client` — TCP framing, CRC-16/CCITT, login (SELECT+LOG_IN), ReceiveFile/SendFile
- `HeidenhainMachine : ICncMachine` — RunGuardedAsync pattern, state machine
### Phase 3: siemens ✅
**Goal:** Implement ICncMachine for Siemens Sinumerik via FTP
**Completed:** 2026-05-13
**Delivered:**
- `SiemensConnectionConfig` — IP, port 21, creds, program dir `/_N_MPF_DIR/`
- `SiemensFtpClient` — FtpWebRequest wrapper, ASCII mode, passive
- `SiemensMachine : ICncMachine`
**Bonus (post-apply):**
- `MitsubishiConnectionConfig` / `MitsubishiFtpClient` / `MitsubishiMachine : ICncMachine`
- `CncManufacturer.Mitsubishi` added to enum + factory + CLI
### Phase 4: program-wiring ✅
**Goal:** Wire all manufacturers into Program.cs + InputArgs
**Completed:** 2026-05-13
**Delivered:**
- `CncMachineFactory` — creates right `ICncMachine` from `InputArgs`
- `InputArgs` — added `manufacturer`, `username`, `password` fields
- `Program.cs` — full rewrite using `ICncMachine` factory; Fanuc 3-file via `IFanucMachine` cast
### Phase 5: nc-validator ✅
**Goal:** Per-manufacturer NC program validator runs inside WriteProgramAsync before upload
**Completed:** 2026-05-13
**Delivered:**
- `ValidationSeverity` / `ValidationError` / `ValidationResult` model types
- `INcProgramValidator` + `NcProgramValidator` with universal + per-manufacturer rules
- Validator injected into all 4 machine classes
- `NcProgramValidatorTests` — 30+ NUnit tests
---
## Next Milestone
**v0.2 NcProgramManager** ✅ Complete
Status: Complete
Phases: 4 of 4 complete
Completed: 2026-05-17
| Phase | Name | Plans | Status | Completed |
|-------|------|-------|--------|-----------|
| 06 | rename-cleanup | 1 | ✅ Complete | 2026-05-17 |
| 07 | license-core | 1 | ✅ Complete | 2026-05-17 |
| 08 | license-integration | 1 | ✅ Complete | 2026-05-17 |
| 09 | license-generator | 1 | ✅ Complete | 2026-05-17 |
### Phase 06: rename-cleanup ✅
**Goal:** Rename FanucProgramManager → NcProgramManager (namespace, project files, test folder). Delete dead FANUCMachine.cs.
**Completed:** 2026-05-17
**Plans:** [x] 06-01: Namespace + file rename
### Phase 07: license-core ✅
**Goal:** `IMachineFingerprint`, `ILicenseValidator`, RSA signature verification, `.lic` file model
**Completed:** 2026-05-17
**Plans:** [x] 07-01: RSA core + interfaces + 6 unit tests
### Phase 08: license-integration ✅
**Goal:** Wire license system into Program.cs, delete `checkLicense`, remove `-chiave=`, hardcode `license.lic` next to EXE
**Completed:** 2026-05-17
**Plans:** [x] 08-01: Program.cs wiring
### Phase 09: license-generator ✅
**Goal:** Separate generator console app — reads machine fingerprint, signs, writes `.lic` file
**Completed:** 2026-05-17
**Plans:** [x] 09-01: LicenseGenerator standalone tool + real public key embedded
---
## Standalone Phases (post-v0.2)
| Phase | Name | Plans | Status |
|-------|------|-------|--------|
| 10 | readme-docs | 1 | ✅ Complete | 2026-05-17 |
### Phase 10: readme-docs ✅
**Goal:** Write Italian README for NcProgramManager and LicenseGenerator repos — describe what each does, prerequisites, setup, CLI usage, license workflow.
**Depends on:** Phase 09 (license workflow complete)
**Plans:** [x] 10-01: Italian READMEs for both repos
---
## Milestone v0.3 — Code Quality ✅
Status: Complete
Phases: 2 of 2 complete
Completed: 2026-05-18
| Phase | Name | Plans | Status | Completed |
|-------|------|-------|--------|-----------|
| 11 | refactor | 2 | ✅ Complete | 2026-05-18 |
| 12 | docs-cli | 1 | ✅ Complete | 2026-05-18 |
### Phase 11: refactor ✅
**Goal:** Clean Architecture refactor of Program.cs — extract ArgParser, fix error handling in Scarica/Invia (try/finally, surface CncResult.Errors), remove AesCrypt dead code.
**Completed:** 2026-05-18
**Plans:**
- [x] 11-01: Extract ArgParser + clean Program.cs structure
- [x] 11-02: Fix Scarica/Invia error handling
### Phase 12: docs-cli ✅
**Goal:** Complete README parameter table — all 16 CLI args with descriptions; error codes with causa + soluzione.
**Completed:** 2026-05-18
**Plans:**
- [x] 12-01: README complete CLI reference + error codes table
---
## Milestone v0.4 — Robustness 🚧
**Status:** In Progress
**Phases:** 0 of 2 complete
**Focus:** Fix high-impact stability issues identified in codebase analysis — null guards, resource disposal, network timeout, and test infrastructure hardening.
| Phase | Name | Plans | Status | Completed |
|-------|------|-------|--------|-----------|
| 13 | robustness-fixes | 1 | Planning | - |
| 14 | test-hardening | TBD | Not started | - |
### Phase 13: robustness-fixes
**Goal:** Fix ISS-001, ISS-005, ISS-006 — null guard on MachineFingerprint WMI properties, dispose SHA256CryptoServiceProvider, fix Lsv2Client connect timeout to actually abort hung task.
**Issues addressed:** ISS-001, ISS-005, ISS-006
**Plans:** TBD (defined during /paul:plan)
### Phase 14: test-hardening
**Goal:** Fix ISS-007, ISS-008 — make integration test IPs configurable via environment variables, add unit tests for MachineFingerprint (mock IMachineFingerprint) and LicenseFile edge cases.
**Issues addressed:** ISS-007, ISS-008
**Plans:** TBD (defined during /paul:plan)
---
*Roadmap updated: 2026-05-18 — v0.4 milestone created.*
Reference in a new issue View git blame Copy permalink