Merge pull request #527 from precice/develop

Release v2404.0

.clang-format

@@ -0,0 +1,119 @@
+---
+Language:        Cpp
+AccessModifierOffset: -2
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: true
+AlignConsecutiveDeclarations: true
+AlignEscapedNewlines: Right
+AlignOperands:   true
+AlignTrailingComments: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: Empty
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: MultiLine
+BinPackArguments: true
+BinPackParameters: true
+BraceWrapping:
+  AfterClass:      false
+  AfterControlStatement: false
+  AfterEnum:       false
+  AfterFunction:   true
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  AfterStruct:     false
+  AfterUnion:      false
+  AfterExternBlock: false
+  BeforeCatch:     false
+  BeforeElse:      false
+  IndentBraces:    false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Custom
+BreakBeforeInheritanceComma: false
+BreakInheritanceList: BeforeColon
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeColon
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+ColumnLimit:     0
+CommentPragmas:  '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DerivePointerAlignment: false
+DisableFormat:   false
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IncludeBlocks:   Preserve
+IncludeCategories:
+  - Regex:           '^(<|"(gtest|isl|json)/)'
+    Priority:        1
+  - Regex:           '.*'
+    Priority:        2
+  - Regex:           '.*'
+    Priority:        1
+IncludeIsMainRegex: '$'
+IndentCaseLabels: false
+IndentPPDirectives: None
+IndentWidth:     2
+IndentWrappedFunctionNames: false
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: true
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBinPackProtocolList: Auto
+ObjCBlockIndentWidth: 2
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 19
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 100
+PointerAlignment: Right
+ReflowComments:  true
+SortIncludes:    true
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: true
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatements
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles:  false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard:        Cpp11
+StatementMacros:
+  - Q_UNUSED
+  - QT_REQUIRE_VERSION
+TabWidth:        2
+UseTab:          Never
+...

.gitattributes

@@ -0,0 +1 @@
+*.tar.gz filter=lfs diff=lfs merge=lfs -text

.github/pull_request_template.md

@@ -1,3 +1,8 @@
 <!-- Please submit your Pull Request to the `develop` branch.
 
 It may help to have a look at the file `CONTRIBUTING.md` for a few hints and guidelines. -->
+
+Checklist:
+
+- [ ] I added a summary of any user-facing changes (compared to the last release) in the `changelog-entries/<PRnumber>.md`.
+- [ ] I will remember to squash-and-merge, providing a useful summary of the changes of this PR.

.github/workflows/check-style.yml

@@ -0,0 +1,37 @@
+name: Check style
+on:
+  push:
+    branches:
+      - master
+      - develop
+  pull_request:
+    branches:
+      - master
+      - develop
+jobs:
+  check_style:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v4
+      - name: Setup python
+        uses: actions/setup-python@v5
+        with:
+         python-version: '3.10'
+         check-latest: true
+      - name: Install pre-commit
+        run: pip install pre-commit
+      - name: Run checks
+        run: pre-commit run -a -v
+      - name: Git status
+        if: always()
+        run: |
+          echo -e '### Status\n```text' >> $GITHUB_STEP_SUMMARY
+          git status | tee -a $GITHUB_STEP_SUMMARY
+          echo '```' >> $GITHUB_STEP_SUMMARY
+      - name: Full diff
+        if: always()
+        run: |
+          echo -e '### Diff\n```diff' >> $GITHUB_STEP_SUMMARY
+          git diff | tee -a $GITHUB_STEP_SUMMARY
+          echo '```' >> $GITHUB_STEP_SUMMARY

.github/workflows/generate_reference_results_manual.yml

@@ -0,0 +1,31 @@
+name: Generate reference results (manual)
+on:
+  workflow_dispatch:
+    inputs:
+      from_ref:
+        description: 'Use the systemtests + tutorial metadata + reference_version from this ref'
+        required: true
+        type: string
+      commit_msg:
+        description: 'Commit msg for commit that adds the reference results'
+        default: "Adding reference results"
+        type: string
+      loglevel:
+        description: 'loglevel used for the systemtests'
+        default: 'INFO'
+        required: true
+        type: choice
+        options:
+            - 'DEBUG'
+            - 'INFO'
+            - 'WARNING'
+            - 'ERROR'
+            - 'CRITICAL'
+
+jobs:
+  generate_reference_results_manual:
+    uses: ./.github/workflows/generate_reference_results_workflow.yml
+    with: 
+      from_ref: ${{ inputs.from_ref }}
+      commit_msg: ${{ inputs.commit_msg }}
+      loglevel: ${{ inputs.loglevel }}

.github/workflows/generate_reference_results_workflow.yml

@@ -0,0 +1,71 @@
+name: Generate reference results workflow
+on:
+  workflow_call:
+    inputs:
+      from_ref:
+        description: 'Use the systemtests + tutorial metadata + reference_version from this ref'
+        required: true
+        type: string
+      commit_msg:
+        description: 'Commit msg for commit that adds the reference results'
+        default: "Adding reference results"
+        type: string
+      loglevel:
+        description: 'loglevel used for the systemtests'
+        default: 'INFO'
+        required: true
+        type: string
+jobs:
+  generate_reference_results:
+    runs-on: [self-hosted, linux, x64, precice-tests-vm]
+    steps:
+    - name: Display a quick job summary
+      run: |
+        echo "Initiated by: ${{ github.actor }}"
+        echo "Running generate_reference_results.py --log-level ${{inputs.loglevel}}"
+        echo "Using Ref: ${{ inputs.from_ref }}"
+        echo "Commit message on success:  ${{ inputs.commit_msg }}"
+    - name: Move LFS URL to local LFS server
+      run: |
+        /home/precice/runners_root/scripts/make_lfs_local.sh
+    - name: 'Cleanup the folder'
+      # The first rf -rf ./* removes all non hidden files
+      # The second rf -rf ./.??* removes all hidden files (but not . and ..)
+      run: |
+        ls -la ./
+        rm -rf ./*
+        rm -rf ./.??*
+        ls -la ./
+    - name: Check out Tutorials for systest
+      uses: actions/checkout@v4
+      with:
+        ref: ${{ inputs.from_ref }}
+        lfs: true
+        fetch-depth: 0
+    - name: Install Python dependencies
+      run: |
+        pip install --user -r tools/tests/requirements.txt
+    - name: Run tests
+      run: |
+        cd tools/tests
+        test -f generate_reference_results.py && export GENERATE_REF_RESULTS=generate_reference_results.py
+        test -f generate_reference_data.py && export GENERATE_REF_RESULTS=generate_reference_data.py
+        echo "Selected $GENERATE_REF_RESULTS to run"
+        python $GENERATE_REF_RESULTS --log-level=${{inputs.loglevel}}
+        cd ../../
+    - name: Create commit
+      if: success()
+      run: |
+        git checkout ${{ inputs.from_ref }}
+        git add ./*/*/*.tar.gz
+        git add ./*/*.tar.gz
+        git add ./*/*.metadata
+        git commit -m "${{inputs.commit_msg}}"
+        git push
+    - name: Upload artifacts for debugging
+      if: failure()
+      uses: actions/upload-artifact@v3
+      with:
+        name: runs
+        path: |
+          runs/*

.github/workflows/run_testsuite_manual.yml

@@ -0,0 +1,45 @@
+name: Run Testsuite (manual) # Unfortunately, we cannot modify the name: https://github.community/t/github-actions-dynamic-name-of-the-workflow-with-workflow-dispatch/150327
+on:
+  workflow_dispatch:
+    inputs:
+      suites:
+        description: 'Comma seperated testsuites to execute'
+        required: true
+        type: string
+      build_args:
+        description: 'Build arguments, if not specified defaults will be taken'
+        required: false
+        type: string
+      systests_branch:
+        description: 'Branch to take the systest from'
+        default: 'develop'
+        required: true
+        type: string
+      loglevel:
+        description: 'loglevel used for the systemtests'
+        default: 'INFO'
+        required: true
+        type: choice
+        options:
+            - 'DEBUG'
+            - 'INFO'
+            - 'WARNING'
+            - 'ERROR'
+            - 'CRITICAL'
+      upload_artifacts:
+        description: 'Upload artifacts also on success (not only on failure)'
+        default: 'FALSE'
+        type: choice
+        options:
+            - 'FALSE'
+            - 'TRUE'
+
+jobs:
+  run_testsuite_manual:
+    uses: ./.github/workflows/run_testsuite_workflow.yml
+    with: 
+      suites: ${{ inputs.suites }}
+      build_args: ${{ inputs.build_args }}
+      systests_branch: ${{ inputs.systests_branch }}
+      loglevel: ${{ inputs.loglevel }}
+      upload_artifacts: ${{ inputs.upload_artifacts }}