Merge pull request #3 from dschwartznyc/cdm-deployment

Merge CDM deployment changes

Author: dschwartz-ftadvisory

.github/workflows/build-and-tag-release-rosetta-bundle.yml

@@ -2,7 +2,6 @@ name: Build and Tag with Rosetta Bundle Version
 
 on:
   workflow_dispatch:
-  # Optionally, you can trigger on push to main or other events
 
 jobs:
   build:
@@ -35,24 +34,17 @@ jobs:
       run: |
         curl -L -o cdm-pom.xml https://raw.githubusercontent.com/finos/common-domain-model/main/pom.xml
 
-    - name: Extract rosetta.bundle.version from external POM
+    - name: Extract rosetta.bundle.version from external POM using Maven
       id: extract_version
       run: |
-        # Try to extract from <properties> first, fallback to profile if needed
-        version=$(xmllint --xpath "string(//properties/rosetta.bundle.version)" cdm-pom.xml)
-        if [ -z "$version" ]; then
-          version=$(xmllint --xpath "string(//profile/properties/rosetta.bundle.version)" cdm-pom.xml)
-        fi
+        version=$(mvn -f cdm-pom.xml help:evaluate -Dexpression=rosetta.bundle.version -q -DforceStdout)
         echo "rosetta.bundle.version=$version"
         echo "version=$version" >> $GITHUB_OUTPUT
 
-    - name: Override rosetta.bundle.version in local pom.xml
+    - name: Update all rosetta.bundle.version properties in local pom.xml using Maven
       run: |
         version="${{ steps.extract_version.outputs.version }}"
-        # Replace in <properties>
-        sed -i "s|<rosetta.bundle.version>.*</rosetta.bundle.version>|<rosetta.bundle.version>${version}</rosetta.bundle.version>|" pom.xml
-        # Replace in <profile> (if present)
-        sed -i "s|<rosetta.bundle.version>.*</rosetta.bundle.version>|<rosetta.bundle.version>${version}</rosetta.bundle.version>|" pom.xml
+        mvn versions:set-property -Dproperty=rosetta.bundle.version -DnewVersion=$version -DprocessAllModules=true
 
     - name: Set POM version to rosetta.bundle.version
       run: |
@@ -63,8 +55,8 @@ jobs:
     - name: Build with Maven
       run: mvn -B package
 
-    - name: Revert POM changes
-      run: git checkout -- pom.xml
+    - name: Revert POM property changes
+      run: mvn versions:revert
 
     - name: Upload JAR files
       uses: actions/upload-artifact@v4

.gitignore

@@ -57,3 +57,4 @@ __pycache__
 **/test/serialization_tests/rune-common
 **/build/common-domain-model
 **/build/resources/serialization
+src/generated/

CDM-Build-Integration.md

@@ -0,0 +1,57 @@
+## Feature Request - CDM Python Generator Integration
+
+### Description of Problem:
+With the Python generator now a standalone component, its integration with the CDM build needs to be updated. This presents two main challenges:
+
+1. **Consistency with CDM's Rosetta Bundle Version:** 
+To keep CDM in sync with all elements of the Rune DSL infrastructure (rosetta-common, rosetta-testing, rosetta-code-generators, rosetta-ingest), the CDM build specifies which version to use. Previously, the Python generator was kept in sync as part of the rosetta-code-generators repository, with updates whenever there was an update to the version in that repository. While the generated Python code does not directly depend on the Rune bundle, coordinating updates across all elements of the Rune infrastructure helps prevent inconsistencies in enterprise production enviroments — especially if a bundle update addresses a defect or changes behavior in a way that impacts the generators.
+
+2. **Invocation of the standalone Python generator**:
+The CDM build now needs to explicitly invoke the unbundled Python generator.
+
+---
+### Potential Solutions:
+
+Below are both a target state and interim steps to enable integration before the target state is fully realized.
+
+### Target state: 
+
+#### Assumptions:
+- The generator includes an executable Main class that accepts a Rune source and a target folder for the generated Python.
+- The Rune Python Runtime is available via PyPI.
+
+#### Process:
+1. An update to the Rosetta Bundle Version triggers a rebuild of the generator.  If successful, a release tagged with the bundle version is generated.
+- Question: What is a viable source for the trigger?  Rosetta-Common?
+- Question: Is the generator uploaded to a central Maven repository or is it solely an artifact of the generator repository.
+2. The CDM build sources a generator version that matches its Rosetta Bundle Version.  The sequence is:
+
+    1. Source the generator
+    2. If found:
+        1. Generate Python by invoking the new Main class using the source CDM Rune files.
+        2. Package the resultung Python.
+        3. Upload the package to PyPI.
+        
+        Question: Should the package also be made available as a Maven artifact?
+    3. If not found: fail gracefully generating notice of the error.
+
+### Interim state: 
+
+#### Assumptions:
+- The generator is invoked using the current mechanism.
+- Python artifacts are distributed via the CDM Maven Repository.
+
+1. A scheduled action rebuilds the generator if the Rosetta Bundle Version used in CDM does not match any of tagged versions.  If successful, a release tagged with the bundle version is generated and stored as a repo artifact.  
+
+_Note: The downside of this approach is that there will be CDM builds that will not find a matching generator._
+
+2. The CDM build sources a generator that matches its Rosetta Bundle Version by querying the generator repo.  The sequence is:
+    1. Source the generator
+    2. If found:
+        1. Generate Python by executing: 
+        ```sh
+        mvn clean install -DskipTests -P python
+        ``` 
+        2. Package the Python.
+        3. Upload the package to the Maven repository.
+    3. If not found: fail gracefully generating notice of the error.

pom.xml

@@ -190,7 +190,7 @@
         <nexus-staging-maven-plugin.version>1.6.13</nexus-staging-maven-plugin.version>
         <maven-gpg-plugin.version>3.2.4</maven-gpg-plugin.version>
         <!-- Used by the Python generator -->
-        <cdm.rosetta.source.path>/Users/dls/projects/cdm/common-domain-model/trade-header/common-domain-model/rosetta-source/src/main/rosetta</cdm.rosetta.source.path>
+        <cdm.rosetta.source.path>[path to rosetta files]</cdm.rosetta.source.path>
         <cdm.python.output.path>target/python-cdm</cdm.python.output.path>
         <unittest.rosetta.source.path>test/python_unit_tests/rosetta</unittest.rosetta.source.path>
         <unittest.python.output.path>target/python-tests/unit_tests</unittest.python.output.path>

src/test/java/com/regnosys/rosetta/generator/python/PythonFilesGeneratorTest.xtend

@@ -37,7 +37,7 @@ class PythonFilesGeneratorTest {
     /*
      * generate CDM from Rosetta files.  Should be disabled for releases
      */
-//    @Disabled
+    @Disabled
     @Test
     def void generateCDMPythonFromRosetta() {
         try {

test/python_unit_tests/rosetta/BinaryOp.rosetta

@@ -1,6 +1,6 @@
 namespace rosetta_dsl.test.semantic.binary_op : <"generate Python unit tests from Rosetta.">
 
-type EqualsTest: <"    Test equals operation condition">
+type EqualsTest: <"Test equals operation condition">
     aValue int (1..1)
     target int (1..1)
     condition TestCond: <"Test condition">
@@ -9,7 +9,7 @@ type EqualsTest: <"    Test equals operation condition">
         else 
             False
 
-type NotEqualsTest: <"    Test not equals operation condition">
+type NotEqualsTest: <"Test not equals operation condition">
     aValue int (1..1)
     target int (1..1)
     condition TestCond: <"Test condition">
@@ -18,7 +18,7 @@ type NotEqualsTest: <"    Test not equals operation condition">
         else 
             False
 
-type ContainsTest: <"    Test contains operation condition">
+type ContainsTest: <"Test contains operation condition">
     aValue string (1..*)
     target string (1..1)
     condition TestCond: <"Test condition">
@@ -27,7 +27,7 @@ type ContainsTest: <"    Test contains operation condition">
         else 
             False
 
-type DisjointTest: <"    Test disjoint operation condition">
+type DisjointTest: <"Test disjoint operation condition">
     aValue string (1..*)
     target string (1..*)
     condition TestCond: <"Test condition">