Merge pull request #9 from decode-development/ci-setup

Implement changes for SDLC - CI pipeline and PR template

Author: timler

.codeclimate.yml

@@ -0,0 +1,49 @@
+version: "2"
+checks:
+  argument-count:
+    enabled: true
+    config:
+      threshold: 4
+  complex-logic:
+    enabled: true
+    config:
+      threshold: 4
+  file-lines:
+    enabled: true
+    config:
+      threshold: 250
+  method-complexity:
+    enabled: true
+    config:
+      threshold: 5
+  method-count:
+    enabled: true
+    config:
+      threshold: 20
+  method-lines:
+    enabled: true
+    config:
+      threshold: 25
+  nested-control-flow:
+    enabled: true
+    config:
+      threshold: 4
+  return-statements:
+    enabled: true
+    config:
+      threshold: 4
+  similar-code:
+    enabled: true
+  identical-code:
+    enabled: true
+
+exclude_patterns:
+- "test/"
+- "tests/"
+- "**/test/"
+- "**/tests/"
+- "**/*Test.java"
+- "build/"
+- "target/"
+- "docs/"
+- "*.md"

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,54 @@
+## Description
+<!--A brief explanation of what was changed, why it was changed and how it was changed. -->
+
+## Type of change
+<!-- Mark relevant items with 'x' -->
+- [ ] New Feature
+- [ ] Bug Fix
+- [ ] Refactor
+- [ ] Documentation Update
+- [ ] Style
+- [ ] Performance Improvements
+- [ ] Test Update
+- [ ] Build/CI Update
+
+## Testing
+<!-- Describe how you tested these changes -->
+- [ ] Unit Tests Added/Updated
+- [ ] Integration Tests Added/Updated
+- [ ] Manual Testing Completed
+### Test Cases
+<!-- List key test scenarios -->
+1. 
+2. 
+
+## Deployment Instructions (optional)
+<!-- Include instructions about any scripts that need to be run -->
+
+## QA Instructions (optional)
+<!-- Include any information that will help a reviewer with testing -->
+
+## Breaking Changes
+<!-- Mark with 'x' if applies -->
+- [ ] This PR introduces breaking changes
+<!-- If yes, describe the impact and migration path -->
+
+## Dependencies
+<!-- List any new dependencies or changes to existing ones -->
+
+## Related Tickets & Documents
+<!-- Include JIRA ticket references and their summary -->
+
+## Screenshots/Recordings
+<!-- If applicable, add screenshots or recordings -->
+
+## Checklist
+<!-- Mark completed items with 'x' -->
+- [ ] Code follows style guidelines
+- [ ] Self-review completed
+- [ ] Tests pass locally
+- [ ] Documentation updated
+- [ ] No new warnings generated
+
+## Additional Notes
+<!-- Any other relevant information -->

.github/workflows/continuous-integration.yml

@@ -0,0 +1,60 @@
+name: Continuous Integration Pipeline
+
+on:
+  push:
+    paths-ignore:
+      - '**.md'
+      - '**.txt'
+      - '**.json'
+      - '**.properties'
+      - '**.xml'
+      - '**.sql'
+      - '**.csv'
+      - '**.zip'
+      - 'docs/**'
+      - '.gitignore'
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  JAVA_VERSION: '17'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - name: Set up JDK
+      uses: actions/setup-java@v3
+      with:
+        java-version: ${{ env.JAVA_VERSION }}
+        distribution: 'temurin'
+        cache: maven
+
+    - name: Run Tests
+      run: mvn test
+
+    - name: Upload JaCoCo reports
+      if: always()
+      uses: actions/upload-artifact@v4
+      with:
+        name: jacoco-reports
+        path: target/site/jacoco/
+
+    - name: Setup Code Climate
+      run: |
+        curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+        chmod +x ./cc-test-reporter
+        ./cc-test-reporter before-build
+
+    - name: Run Code Climate Analysis
+      env:
+        CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+      run: |
+        JACOCO_SOURCE_PATH=src/main/java ./cc-test-reporter format-coverage target/site/jacoco/jacoco.xml --input-type jacoco
+        ./cc-test-reporter upload-coverage

pom.xml

@@ -17,6 +17,10 @@
 
     <properties>
         <java.version>17</java.version>
+        <sonar.coverage.exclusions>
+            **/model/**,**/dto/**
+        </sonar.coverage.exclusions>
+        <jacoco.minimum.coverage>0.80</jacoco.minimum.coverage>
     </properties>
 
     <dependencies>
@@ -156,7 +160,29 @@
                     <executable>true</executable>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>org.jacoco</groupId>
+                <artifactId>jacoco-maven-plugin</artifactId>
+                <version>0.8.8</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>prepare-agent</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>report</id>
+                        <phase>test</phase>
+                        <goals>
+                            <goal>report</goal>
+                        </goals>
+                        <configuration>
+                            <outputDirectory>${project.build.directory}/site/jacoco</outputDirectory>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 
-</project>
+</project>