Added Xdebug Support to Circle CI for Code Coverage (#2006)

* added code_coverage capabilities to xdmod

---------

Co-authored-by: Alex Tovar <[email protected]>

Author: rvtovar

.circleci/config.yml

@@ -17,6 +17,8 @@ jobs:
         type: string
       string_os:
         type: string
+      schedule-name:
+        type: string
     executor: << parameters.os >>
     environment:
       COMPOSER_ALLOW_SUPERUSER: 1
@@ -55,6 +57,8 @@ jobs:
           command: |
             docker exec xdmod mkdir /root/phpunit
             docker exec xdmod mkdir /tmp/screenshots
+            docker exec xdmod mkdir /root/code_coverage_raw
+            docker exec xdmod mkdir /root/code_coverage
       - run:
           name: Install XDMoD Composer Dependencies
           command: docker exec -w /root/xdmod xdmod composer install
@@ -100,6 +104,18 @@ jobs:
       - run:
           name: Make sure that the Test Dependencies are installed
           command: docker exec -w /root/xdmod xdmod composer install --no-progress
+      - when:
+          condition:
+            and:
+              - equal: [ scheduled_pipeline, << pipeline.trigger_source >> ]
+              - equal: [ "xdmod-time-trigger", << pipeline.schedule.name >> ]
+
+          steps:
+            - run:
+                name: Installing Code Coverage Dependencies
+                command: |
+                  docker exec -w /root/xdmod xdmod /root/xdmod/tools/dev/code_coverage/codeCoverageSetup.sh -b . -x /root/xdmod/tools/dev/code_coverage/start_xdebug.php -p /root/xdmod/tools/dev/code_coverage/combine_xdebug.php
+
       - run:
           name: Run Regression Tests
           command: docker exec -e XDMOD_TEST_MODE=<< parameters.install-type >> -w /root/xdmod xdmod /root/xdmod/tests/regression/runtests.sh
@@ -110,6 +126,7 @@ jobs:
             docker exec xdmod mv /root/xdmod/configuration/portal_settings.ini /root/xdmod/configuration/portal_settings.ini.old
             docker exec xdmod cp /etc/xdmod/portal_settings.ini /root/xdmod/configuration/portal_settings.ini
             docker exec xdmod cp /etc/xdmod/organization.json /root/xdmod/configuration/organization.json
+
       - run:
           name: Running Integration Tests
           command: docker exec -w /root/xdmod xdmod /root/xdmod/tests/integration/runtests.sh --junit-output-dir /root/phpunit
@@ -128,6 +145,23 @@ jobs:
       - run:
           name: Run Playwright Tests
           command: docker exec -w /root/xdmod/tests/playwright playwright /root/xdmod/tests/playwright/runtests.sh -j << parameters.string_os >>
+      - when:
+          condition:
+            and:
+              - equal: [ scheduled_pipeline, << pipeline.trigger_source >> ]
+              - equal: [ "xdmod-time-trigger", << pipeline.schedule.name >> ]
+          steps:
+            - run:
+                name: Process Code Coverage Data
+                no_output_timeout: 120m
+                command: docker exec -w /root/xdmod xdmod /root/xdmod/tools/dev/code_coverage/codeCoverageProcess.sh -i /root/code_coverage_raw
+            - run:
+                name: Tar Up Code Coverage Report for later download
+                command: docker exec -it xdmod sh -c "tar -czvf ~/code_coverage/report.tgz ~/code_coverage_raw"
+            - run:
+                name: Copy Code Coverage Report to Host
+                command: docker cp xdmod:/root/code_coverage ~/code_coverage
+
       - run:
           name: Copy Test Results into Unit
           command: |
@@ -175,6 +209,16 @@ jobs:
           path: /root/xdmod/logs
       - store_test_results:
           path: ~/phpunit
+      - when:
+          condition:
+            and:
+              - equal: ["xdmod-time-trigger", << parameters.schedule-name >>]
+          #            and:
+          #              - equal: [ scheduled_pipeline, << pipeline.trigger_source >> ]
+          #              - equal: [ "xdmod-time-trigger", << pipeline.schedule.name >> ]
+          steps:
+            - store_artifacts:
+                path: ~/code_coverage
 
 workflows:
   full-build:
@@ -185,3 +229,4 @@ workflows:
               os: [rocky8]
               install-type: ["fresh_install", "upgrade"]
               string_os: [rocky8]
+              schedule-name: ["xdmod-time-trigger"]