How sap/abap-atc-cr-cv-s4hc works
Project type and purpose
• This is a hybrid “data‐repository + static‐site viewer” project.
• It stores SAP S/4HANA Cloud released/not‐released API metadata (CSV and JSON files), provides a Node.js script to generate JSON from CSV, and offers a React-based “Cloudification API Viewer” UI.
• It also supplies raw JSON endpoints consumed by the ABAP Test Cockpit (ATC) check in SAP systems.
File structure
• Top-level:
• .github/workflows/ci.yml → CI/CD pipeline
• scripts/ → data-generation script (generateContents.js)
• src/ → raw CSV & JSON data files (objectReleaseInfo*.json/csv, objectClassifications*.json/csv)
• test/ → test fixtures for validation
• viewer/ → React single-page application + Cypress E2E tests
• Patterns & concerns:
• Separation of data files vs. viewer code
• CI pipeline builds & tests both data integrity and viewer, then deploys static site to GitHub Pages
• Use of raw.githubusercontent.com URLs for consumption by external ATC checks
Main components and their interactions
a. Data Generation Component (Node.js script)
• Input: CSV files under src/
• Output: JSON files under src/
• Lives in scripts/generateContents.js
b. Data Store (Git repository)
• Stores all CSV & JSON artifacts
• Source of truth for SAP released API metadata
c. CI/CD Pipeline (GitHub Actions)
• Runs lint, unit tests (if any), data-validation tests (test/), builds viewer, runs Cypress E2E
• Deploys viewer to GitHub Pages; ensures JSON files stay in sync
d. Viewer (React SPA)
• Served as static assets (HTML/CSS/JS)
• Fetches JSON from raw.githubusercontent.com based on query param “version”
• Renders tables, filters, tabs, and detail popovers
e. External Consumers
• ABAP Test Cockpit (SAP BTP) reads the JSON endpoints directly via HTTP
• Other tools/spreadsheets can consume CSV or JSON offline
Architectural patterns and design principles
• Layered architecture:
• Data-layer (CSV/JSON files)
• Transformation layer (scripts)
• Presentation layer (React viewer)
• Integration layer (CI/CD, hosting, external ATC check)
• Single Responsibility: each directory holds one concern
• Static-site architecture: no server-side runtime; all logic in build step or client
• Unidirectional data flow in React components