Add export to SysML and to PlantUML

.github/workflows/main.yml

@@ -0,0 +1,117 @@
+# This is a basic workflow to help you get started with Actions
+
+name: CI
+
+# Controls when the workflow will run
+on:
+  push:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  build_package:
+    name: Builld chocosolver package
+    runs-on: ubuntu-20.04
+    steps:
+      #### This step is only needed for GHA local runner, act: https://github.com/nektos/act
+      ### That is because act ubuntu image does not have mvn installed, but the github one does
+      # - name: Install curl (for nektos/act local CI testing)
+      #   run: apt-get update && apt-get install build-essential curl pkg-config openssl -y
+      # - name: Download Maven
+      #   run: |
+      #     curl -sL https://downloads.apache.org/maven/maven-3/3.8.8/binaries/apache-maven-3.8.8-bin.zip -o maven.zip
+      #     apt-get update
+      #     apt-get -y install unzip
+      #     unzip -d /usr/share maven.zip
+      #     rm maven.zip
+      #     ln -s /usr/share/apache-maven-3.8.8/bin/mvn /usr/bin/mvn
+      #     echo "M2_HOME=/usr/share/apache-maven-3.8.8" | tee -a /etc/environment
+      #     file /usr/bin/mvn
+      #     echo $PATH
+      # Rest of the actions
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          java-version: '8'
+          distribution: 'temurin'
+      - run: mvn --batch-mode --update-snapshots verify
+      - run: mkdir staging && cp target/*.jar staging
+      - uses: actions/upload-artifact@v4
+        with:
+          name: chocosolver-release
+          path: staging/*.jar
+          retention-days: 7
+
+  test_sysml_export:
+    name: Test SysMLv2 export
+    needs: build_package
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download Chocosolver package
+        uses: actions/download-artifact@v4
+        with:
+          name: chocosolver-release
+          path: /tmp/chocosolver-release
+      - name: Install clafer tools
+        run: |
+          wget --no-check-certificate https://gsd.uwaterloo.ca/clafer-tools-bin/clafer-tools-0.4.5-linux-x86_64.zip
+          unzip clafer-tools-0.4.5-linux-x86_64.zip
+          mv clafer-tools-0.4.5 /opt/clafer-tools-0.4.5
+          echo "/opt/clafer-tools-0.4.5" >> $GITHUB_PATH
+      - name: Process SysML examples
+        shell: bash
+        run: |
+          for f in examples/sysml-samples/*.cfr
+          do
+            echo "Processing $f"
+            java -jar /tmp/chocosolver-release/chocosolver-0.4.4-jar-with-dependencies.jar --sysml --file $f --output $f.sysml
+          done
+      - uses: actions/upload-artifact@v4
+        with:
+            name: SysML_generated
+            path: examples/sysml-samples/*.sysml
+            retention-days: 7
+
+  test_plantuml_export:
+    name: Test PlantUML export
+    needs: build_package
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download Chocosolver package
+        uses: actions/download-artifact@v4
+        with:
+          name: chocosolver-release
+          path: /tmp/chocosolver-release
+      - name: Install clafer tools
+        shell: bash
+        run: |
+          wget --no-check-certificate https://gsd.uwaterloo.ca/clafer-tools-bin/clafer-tools-0.4.5-linux-x86_64.zip
+          unzip clafer-tools-0.4.5-linux-x86_64.zip
+          mv clafer-tools-0.4.5 /opt/clafer-tools-0.4.5
+          echo "/opt/clafer-tools-0.4.5" >> $GITHUB_PATH
+      - name: Install PlantUML
+        run: |
+          wget https://github.com/plantuml/plantuml/releases/download/v1.2023.4/plantuml-1.2023.4.jar
+      - name: Install graphviz
+        run: |
+          sudo apt-get update
+          sudo apt-get install graphviz
+      - name: Process SysML examples
+        run: |
+          for f in examples/**.cfr
+          do
+            echo "Processing $f"
+            java -jar /tmp/chocosolver-release/chocosolver-0.4.4-jar-with-dependencies.jar --plantuml --file $f --output $f.plantuml
+            java -jar /tmp/chocosolver-release/chocosolver-0.4.4-jar-with-dependencies.jar --sysml --file $f --output $f.sysml
+            echo "Rendering $f.plantuml"
+            java -jar plantuml-1.2023.4.jar $f.plantuml
+          done
+      - uses: actions/upload-artifact@v4
+        with:
+            name: PlantUML_generated
+            path: |
+              examples/**.plantuml
+              examples/**.sysml
+              examples/**.png
+            retention-days: 7

.gitignore

@@ -2,3 +2,7 @@ target
 nb-configuration.xml
 nbactions.xml
 src/test/resources/user.properties
+.idea
+*.plantuml
+*.js
+

.gitlab-ci.yml

@@ -0,0 +1,91 @@
+stages:
+  - build
+  - test
+  - deploy
+
+image: maven:3.6-jdk-11
+
+before_script:
+  - export PATH="$PWD/clafer-tools-0.4.5:$PATH"
+
+prepare_environment:
+  stage: build
+  script:
+    - wget --no-check-certificate https://gsd.uwaterloo.ca/clafer-tools-bin/clafer-tools-0.4.5-linux-x86_64.zip
+    - unzip clafer-tools-0.4.5-linux-x86_64.zip
+  artifacts:
+    when: always
+    paths:
+      - clafer-tools-0.4.5/
+    expire_in: 1 hour
+
+build_package:
+  stage: build
+  tags: ["stardust"]
+  script:
+    - mvn package
+  artifacts:
+    when: always
+    paths:
+      - target/chocosolver-0.4.4-jar-with-dependencies.jar
+    expire_in: 1 week
+
+test_sysml_export:
+  stage: test
+  needs:
+    - job: build_package
+      artifacts: true
+    - job: prepare_environment
+      artifacts: true
+  script: 
+    - |
+      for f in examples/sysml-samples/*.cfr
+      do 
+        echo "Processing $f"
+        java -jar target/chocosolver-0.4.4-jar-with-dependencies.jar --sysml --file $f --output $f.sysml
+      done
+  artifacts:
+    when: always
+    paths:
+      - ./examples/sysml-samples/*.sysml
+    expire_in: 1 week
+
+test_plantuml_export:
+  stage: test
+  needs:
+    - job: build_package
+      artifacts: true
+    - job: prepare_environment
+      artifacts: true
+  script:
+    - wget https://github.com/plantuml/plantuml/releases/download/v1.2023.4/plantuml-1.2023.4.jar
+    - apt-get update && apt-get install -y graphviz
+    - |
+      for f in examples/**/*.cfr
+      do 
+        echo "Processing $f"
+        java -jar target/chocosolver-0.4.4-jar-with-dependencies.jar --plantuml --file $f --output $f.plantuml
+        java -jar target/chocosolver-0.4.4-jar-with-dependencies.jar --sysml --file $f --output $f.sysml
+        echo "Rendering $f.plantuml"
+        java -jar plantuml-1.2023.4.jar $f.plantuml
+      done
+  artifacts:
+    when: always
+    paths:
+      - ./examples/*.plantuml
+      - ./examples/*.sysml
+      - ./examples/*.png
+    expire_in: 1 week
+
+deploy_job:
+  stage: deploy
+  needs:
+    - job: build_package
+      artifacts: true
+    - job: prepare_environment
+      artifacts: true
+  script:
+    - 'echo "Deploying the project to GitLab Package Registry..."'
+    - 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file ./target/chocosolver-0.4.4-jar-with-dependencies.jar "https://gitlab-ext.galois.com/api/v4/projects/$CI_PROJECT_ID/packages/maven/"'
+  only:
+    - tags

README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://secure.travis-ci.org/gsdlab/chocosolver.svg)](http://travis-ci.org/gsdlab/chocosolver)
+[![Build Status](https://github.com/EthanJamesLew/chocosolver-sysml/actions/workflows/maven.yml/badge.svg)](https://github.com/EthanJamesLew/chocosolver-sysml/actions/workflows/maven.yml)
 
 # chocosolver
 

examples/AndroidSampleMoo_2.cfr

@@ -0,0 +1,58 @@
+abstract Component
+    performance : integer
+
+abstract ComponentWithEnergy : Component
+    energy : integer
+
+abstract androidPhone
+    hardware : Component
+        [ performance = 0 ]
+        screen : Component
+            [ performance = 0 ]
+            xor material : Component
+                [ performance = 0 ]
+                oled : ComponentWithEnergy
+                    [ energy = 3]
+                    [ performance = -3 ]
+                amoled : ComponentWithEnergy
+                    [ energy = 2 ]
+                    [ performance = -5 ] 
+                lcd : ComponentWithEnergy
+                    [ energy = 4 ]
+                    [ performance = -2 ]
+        keyboard : ComponentWithEnergy ?
+            [ energy = 1 ]
+            [ performance = 3 ]
+        keyboardLight : ComponentWithEnergy ?
+            [ energy = 2 ]
+            [ performance = -1 ]
+            [ keyboard ]
+        cpu : ComponentWithEnergy
+            [ energy = 10 ]
+            [ performance = 15 ]
+        extra_cpu : ComponentWithEnergy ?
+            [ energy = 2 ]
+            [ performance = 20 ]
+    or location : Component ?
+        [ performance = 0 ]
+        gps : ComponentWithEnergy
+            [ energy = 5 ]
+            [ performance = -1 ]
+        wifitriangulation : ComponentWithEnergy
+            [ energy = 10 ]
+            [ performance = -2 ]
+    software : Component
+        [ performance = 0 ]
+        browser : Component ?
+            [ performance = -1 ]
+            [ extra_cpu ]
+        mediaplayer : Component ?
+            [ performance = -2 ]
+    total_performance : integer = sum Component.performance
+    total_energy : integer = sum ComponentWithEnergy.energy
+
+aPhone : androidPhone
+    [ mediaplayer ]
+
+<< min aPhone.total_energy >>
+<< max aPhone.total_performance >>

examples/AndroidSampleMoo_3.cfr

@@ -0,0 +1,42 @@
+abstract Feature
+    performance : integer
+    energy : integer
+
+abstract SecurityFeature : Feature
+    security : integer
+
+abstract MobilePhone
+    or Connectivity : Feature
+        [ this.performance = 0]
+        [ this.energy = 0]
+        Bluetooth : Feature
+            [ this.performance = 9]
+            [ this.energy = 10 ]        
+        USB : Feature
+            [ this.performance = 15]
+            [ this.energy = 7 ]        
+        Wifi : Feature    
+            [ this.performance = 22]
+            [ this.energy = 17 ]
+    PasswordProtection : SecurityFeature ?
+        [ this.security = 5]
+        [ this.performance = 1]
+        [ this.energy = 2 ]
+    FingerprintProtection : SecurityFeature ?
+        [ this.security = 5]
+        [ this.performance = 2]
+        [ this.energy = 4 ]
+    total_performance : integer
+    [ total_performance = sum Feature.performance ]
+    total_energy : integer
+    [ total_energy = sum Feature.energy ]
+    total_security : integer
+    [ total_security = sum SecurityFeature.security ]
+
+MyPhone : MobilePhone
+    [ Connectivity.Bluetooth && !USB  ]
+
+<< min MyPhone.total_energy >>
+<< max MyPhone.total_performance >>
+<< max MyPhone.total_security >>
+

examples/AndroidSampleMoo_4.cfr

@@ -0,0 +1,50 @@
+abstract Feature
+    performance : integer
+    energy : integer
+    mass: integer
+
+abstract SecurityFeature : Feature
+    security : integer
+
+abstract MobilePhone
+    or Connectivity : Feature
+        [ this.performance = 0]
+        [ this.energy = 0]
+        [ this.mass = 0]
+        Bluetooth : Feature
+            [ this.performance = 9]
+            [ this.energy = 10 ]        
+            [ this.mass = 2]
+        USB : Feature
+            [ this.performance = 10]
+            [ this.energy = 5 ]        
+            [ this.mass = 3]
+        Wifi : Feature    
+            [ this.performance = 22]
+            [ this.energy = 17 ]
+            [ this.mass = 6]
+    PasswordProtection : SecurityFeature ?
+        [ this.security = 5]
+        [ this.performance = 1]
+        [ this.energy = 2 ]
+        [ this.mass = 0]
+    FingerprintProtection : SecurityFeature ?
+        [ this.mass = 0]
+        [ this.security = 5]
+        [ this.performance = 2]
+        [ this.energy = 4 ]
+    total_performance : integer
+    [ total_performance = sum Feature.performance ]
+    total_energy : integer
+    [ total_energy = sum Feature.energy ]
+    total_security : integer
+    [ total_security = sum SecurityFeature.security ]
+    total_mass : integer
+    [ total_mass = sum Feature.mass ]
+
+MyPhone : MobilePhone
+
+<< min MyPhone.total_energy >>
+<< max MyPhone.total_performance >>
+<< max MyPhone.total_security >>
+<< min MyPhone.total_mass >>