How trevor-dolby-at-ibm-com/ace-submodule-subflowlib-level1 works
Project type and purpose
• This is a mid-level shared library repository for IBM App Connect Enterprise (ACE).
• It provides a reusable subflow (AddHTTPHeader) implemented in ESQL, and relies on a lower-level Java submodule.
• It includes both unit tests and contract tests, and is intended to be consumed by a “real” ACE application (App1).
File structure
• Top-level:
• .github/workflows/ace-ci.yml → GitHub Actions CI pipeline
• build-and-ut.sh, build-and-run-contract-tests.sh → Local build/test drivers
• SubflowLibLevel1/… → The actual ESQL subflow library project
• ace-submodule-javalib-level1 (git submodule) → Java helper library
• SubflowLibLevel1_ScaffoldApp/… → A minimal ACE app that imports the library for testing
• SubflowLibLevel1_UnitTest/… → JUnit-style unit tests invoking the scaffold
• SubflowLibLevel1_ContractTest/… → Contract tests using sample input/output from the real app
• Pattern: a mono-repo of multiple Eclipse/ACE projects (the library, scaffold app, test projects).
README for additional insights
• Confirms multi-repo hierarchy: App1 ← SubflowLibLevel1 ← JavaLibLevel1
• Tests ensure both library correctness and interface stability from the consumer’s POV.
• CI automates build + all tests via GitHub Actions.
Components
a. Main components
• SubflowLibLevel1 (ESQL subflow library)
• Java library submodule (ace-submodule-javalib-level1)
• ScaffoldApp (instantiates the subflow)
• UnitTest project
• ContractTest project
• CI Pipeline (GitHub Actions)
b. Relationships and interactions
• SubflowLibLevel1 depends on JavaLibLevel1.
• ScaffoldApp imports SubflowLibLevel1 (and transitively JavaLibLevel1).
• UnitTest and ContractTest both launch flows in ScaffoldApp to exercise the subflow.
• build-and-ut.sh builds the library and runs UnitTest; build-and-run-contract-tests.sh runs ContractTest.
• CI workflow triggers both scripts on PR.
c. Architectural patterns / principles
• Modular subflow library enabling reuse across multiple ACE apps.
• Test-driven approach: scaffold app for isolation, contract tests for integration stability.
• Git submodules for multi-repo dependency management.
d. Relevant technologies
• IBM App Connect Enterprise (message flow, ESQL compute node)
• Java (for auxiliary logic)
• Maven/Gradle or shell scripts (build-and-ut.sh)
• JUnit (for UnitTest, ContractTest)
• GitHub Actions (CI)