396 / 376 / 347 / 358 / 409 / 357 / 400 / 411: contains all the changes for optical that currently stands

.github/workflows/gradle.yml

@@ -23,55 +23,98 @@ jobs:
 
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout this  repo
-      uses: actions/checkout@v4
-      with:
+      - name: Checkout this repo (main)
+        uses: actions/checkout@v4
+        with:
           path: main
 
-    - name: Checkout common build repo
-      uses: actions/checkout@v4
-      with:
-        repository: orppst/build-logic
-        path: build-logic
-
-    - name: Checkout common lib
-      uses: actions/checkout@v4
-      with:
-        repository: orppst/pst-lib
-        path: pst-lib
-
-    - name: Set up JDK 17
-      uses: actions/setup-java@v4
-      with:
-        java-version: '17'
-        distribution: 'temurin'
-
-    - name: Setup Gradle
-      uses: gradle/gradle-build-action@v3
-      with:
-        build-root-directory: main
-        cache-disabled: true
-        cache-overwrite-existing: true
-    - name: Run Gradle build
-      working-directory: ./main
-      run: ./gradlew -U build -x test -Dquarkus.container-image.builder=none
-
-    - name: Upload interface definition
-      uses: actions/upload-artifact@v4
-      with:
-        # Artifact name
-        name: openapi
-        # A file, directory or wildcard pattern that describes what to upload
-        path: ./main/build/generated/openapi/openapi.yaml
-
-    - name: Run Gradle test
-      working-directory: ./main
-      run: ./gradlew  --info test
-
-    - name: Publish Test Results
-      uses: EnricoMi/publish-unit-test-result-action@v2
-      if: always()
-      with:
-        files: |
-          main/build/test-results/**/*.xml
-
+      - name: Checkout common build repo (build-logic)
+        uses: actions/checkout@v4
+        continue-on-error: true
+        id: checkoutBuild-logic
+        with:
+          repository: orppst/build-logic
+          path: build-logic
+          ref: ${{ github.event.pull_request && github.event.pull_request.head.ref || github.ref_name }}
+
+      - name: Check if build-logic checkout succeeded
+        if: steps.checkoutBuild-logic.outcome == 'failure'
+        uses: actions/checkout@v4
+        with:
+          repository: orppst/build-logic
+          path: build-logic
+          ref: master
+
+      - name: Checkout common lib (pst-lib)
+        uses: actions/checkout@v4
+        continue-on-error: true
+        id: checkoutPst-lib
+        with:
+          repository: orppst/pst-lib
+          path: pst-lib
+          ref: ${{ github.event.pull_request && github.event.pull_request.head.ref || github.ref_name }}
+
+
+      - name: Check if pst-lib checkout succeeded
+        if: steps.checkoutPst-lib.outcome == 'failure'
+        uses: actions/checkout@v4
+        with:
+          repository: orppst/pst-lib
+          path: pst-lib
+          ref: master
+
+      - name: Checkout telescope repo (telescope-config-data)
+        uses: actions/checkout@v4
+        continue-on-error: true
+        id: checkoutTelescope-config-data
+        with:
+          repository: orppst/telescope-config-data
+          path: telescope-config-data
+          ref: ${{ github.event.pull_request && github.event.pull_request.head.ref || github.ref_name }}
+
+
+      - name: Check if telescope-config-data checkout succeeded
+        if: steps.checkoutTelescope-config-data.outcome == 'failure'
+        uses: actions/checkout@v4
+        with:
+          repository: orppst/telescope-config-data
+          path: telescope-config-data
+          ref: main
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v3
+        with:
+          build-root-directory: main
+          cache-disabled: true
+          cache-overwrite-existing: true
+
+      - name: Run Gradle build
+        working-directory: ./main
+        run: ./gradlew -U build -x test -Dquarkus.container-image.builder=none
+
+      - name: Upload interface definition
+        uses: actions/upload-artifact@v4
+        with:
+          # Artifact name
+          name: openapi
+          # A file, directory or wildcard pattern that describes what to upload
+          path: ./main/build/generated/openapi/openapi.yaml
+
+      - name: Run Gradle test
+        working-directory: ./main
+        env:
+          POLARIS_TELESCOPE_CONFIG_LOCATION: /home/runner/work/pst-api-service/pst-api-service/telescope-config-data/
+        run: ./gradlew --info test
+
+      - name: Publish Test Results
+        uses: EnricoMi/publish-unit-test-result-action@v2
+        if: always()
+        with:
+          files: |
+            main/build/test-results/**/*.xml

src/main/java/org/orph2020/pst/AppLifecycleBean.java

@@ -5,10 +5,13 @@
 
 import io.quarkus.runtime.ShutdownEvent;
 import io.quarkus.runtime.StartupEvent;
+import jakarta.enterprise.inject.Produces;
 import jakarta.inject.Inject;
+import jakarta.inject.Singleton;
 import org.apache.commons.io.FileUtils;
 import org.eclipse.microprofile.config.inject.ConfigProperty;
 import org.ivoa.dm.proposal.management.ProposalCycle;
+import org.ivoa.dm.proposal.management.Telescope;
 import org.ivoa.dm.proposal.prop.*;
 import org.jboss.logging.Logger;
 import org.orph2020.pst.apiimpl.entities.SubjectMap;
@@ -19,6 +22,7 @@
 import jakarta.persistence.PersistenceContext;
 import jakarta.persistence.TypedQuery;
 import jakarta.transaction.Transactional;
+import org.orph2020.pst.apiimpl.entities.opticalTelescopeService.XmlReaderService;
 import org.orph2020.pst.apiimpl.rest.ProposalDocumentStore;
 
 import java.io.File;
@@ -31,37 +35,138 @@
 @ApplicationScoped
 public class AppLifecycleBean {
 
+    // constant environmental value for where telescope data is located.
+    private static final String POLARIS_MODE_ENV_NAME =
+        "POLARIS_TELESCOPE_MODE";
+
+    // makes a string based enum with text. to help iterate.
+    public enum MODES {
+        OPTICAL("OPTICAL", 0),
+        RADIO("RADIO", 1),
+        BOTH("BOTH", 2);
+
+        private final String text;
+        private final int number;
+
+        MODES(String text, int number) {
+            this.text = text;
+            this.number = number;
+        }
+
+        public String getText() {
+            return text;
+        }
+        public int getValue() { return number; }
+    }
+
+    // exists for the application lifetime no need to close
     @PersistenceContext
-    protected EntityManager em;  // exists for the application lifetime no need to close
+    protected EntityManager em;
 
     @ConfigProperty(name = "document-store.proposals.root")
     String documentStoreRoot;
 
     @Inject
     ProposalDocumentStore proposalDocumentStore;
 
+    // reader for xml files
+    XmlReaderService xmlReader;
+
+    // store for the polaris mode
+    MODES polarisMode;
+
     private static final Logger LOGGER = Logger.getLogger("ListenerBean");
 
+    // produces the array of telescopes.
+    @Singleton
+    @Produces
+    XmlReaderService produceTelescopes() {
+        return this.xmlReader;
+    }
+
+    // produces the holder for the polaris mode.
+    @Singleton
+    @Produces
+    MODES mode() { return this.polarisMode; }
+
 
     @Transactional
     void onStart(@Observes StartupEvent ev) {
         LOGGER.info("The application is starting...");
+        this.initialiseDatabase();
+        this.initialiseOpticalTelescopeDatabase();
+        this.initialisePolarisMode();
+    }
+
+    /**
+     * processes the environment variable for the polaris mode.
+     */
+    private void initialisePolarisMode() {
+        String environmentMode = System.getenv(POLARIS_MODE_ENV_NAME);
+
+        // handle when no environment variable is set.
+        if(environmentMode == null) {
+            this.polarisMode = MODES.RADIO;
+            LOGGER.log(
+                Logger.Level.WARN,
+                "no environment variable was set for" +
+                POLARIS_MODE_ENV_NAME + ", so defaulting to RADIO setting.");
+        }
+
+        switch (MODES.valueOf(environmentMode)) {
+            case RADIO -> this.polarisMode = MODES.RADIO;
+            case OPTICAL -> this.polarisMode = MODES.OPTICAL;
+            case BOTH -> this.polarisMode = MODES.BOTH;
+            default -> {
+                LOGGER.error("NO valid mode was detected. setting to radio.");
+                this.polarisMode = MODES.RADIO;
+            }
+        }
+    }
+
+    /**
+     * builds the optic telescope database.
+     */
+    private void initialiseOpticalTelescopeDatabase() {
+        xmlReader = new XmlReaderService();
+        xmlReader.read();
+
+        // add telescopes to the proposal management system.
+        for (String telescopeName: xmlReader.getTelescopes().keySet()) {
+            Telescope managementTelescope = new Telescope();
+            managementTelescope.setName(telescopeName);
+            em.persist(managementTelescope);
+        }
+    }
 
-        Long i = em.createQuery("select count(o) from Observatory o", Long.class).getSingleResult();
+    /**
+     * builds the basic database that contains proposals and such.
+     */
+    private void initialiseDatabase() {
+        Long i = em.createQuery(
+            "select count(o) from Observatory o", Long.class).getSingleResult();
         if(i.intValue() == 0) {
             LOGGER.info("initializing Database");
-           // add the example proposals.
+            // add the example proposals.
             FullExample fullExample = new FullExample();
-            List<ProposalCycle> cycles = fullExample.getManagementModel().getContent(ProposalCycle.class);
+            List<ProposalCycle> cycles = fullExample.getManagementModel().
+                getContent(ProposalCycle.class);
             LocalDate now = LocalDate.now();
             for (ProposalCycle cycle : cycles) {
-                cycle.setSubmissionDeadline(new Date(now.plusWeeks(2).atStartOfDay().atOffset(ZoneOffset.UTC).toEpochSecond()*1000));
-                cycle.setObservationSessionStart(new Date(now.plusMonths(2).atStartOfDay().atOffset(ZoneOffset.UTC).toEpochSecond()*1000));
-                cycle.setObservationSessionEnd(new Date(now.plusMonths(6).atStartOfDay().atOffset(ZoneOffset.UTC).toEpochSecond()*1000));
+                cycle.setSubmissionDeadline(
+                    new Date(now.plusWeeks(2).atStartOfDay().atOffset(
+                        ZoneOffset.UTC).toEpochSecond()*1000));
+                cycle.setObservationSessionStart(
+                    new Date(now.plusMonths(2).atStartOfDay().atOffset(
+                        ZoneOffset.UTC).toEpochSecond()*1000));
+                cycle.setObservationSessionEnd(
+                    new Date(now.plusMonths(6).atStartOfDay().atOffset(
+                        ZoneOffset.UTC).toEpochSecond()*1000));
             }
             fullExample.saveTodB(em);
 
-            for(ObservingProposal pr: fullExample.getProposalModel().getContent(ObservingProposal.class))
+            for(ObservingProposal pr: fullExample.getProposalModel().getContent(
+                ObservingProposal.class))
                 try {
                     proposalDocumentStore.createStorePaths(pr.getId());
                 } catch (IOException e) {
@@ -71,24 +176,31 @@ void onStart(@Observes StartupEvent ev) {
         }
 
         //only try to populate the SubjectMap if not already done
-        TypedQuery<SubjectMap> sq = em.createQuery("select o from SubjectMap o where o.uid = 'bb0b065f-6dc3-4062-9b3e-525c1a1a9bec'", SubjectMap.class);
+        TypedQuery<SubjectMap> sq = em.createQuery(
+            "select o from SubjectMap o where o.uid = " +
+                "'bb0b065f-6dc3-4062-9b3e-525c1a1a9bec'", SubjectMap.class);
         if(sq.getResultList().isEmpty()) {
 
-            TypedQuery<Person> pq = em.createQuery("select o from Person o", Person.class);
+            TypedQuery<Person> pq = em.createQuery(
+                "select o from Person o", Person.class);
             for (Person p : pq.getResultList()) {
                 switch (p.getEMail()) {
                     case "pi@unreal.not.email":
 
-                        em.persist(new SubjectMap(p, "bb0b065f-6dc3-4062-9b3e-525c1a1a9bec"));
+                        em.persist(new SubjectMap(p,
+                            "bb0b065f-6dc3-4062-9b3e-525c1a1a9bec"));
                         break;
                     case "reviewer@unreal.not.email":
-                        em.persist(new SubjectMap(p, "dda2fd0b-8bb4-4dd1-a216-f75087f3d946"));
+                        em.persist(new SubjectMap(p,
+                            "dda2fd0b-8bb4-4dd1-a216-f75087f3d946"));
                         break;
                     case "tacchair@unreal.not.email":
-                        em.persist(new SubjectMap(p, "b0f7b98e-ec1e-4cf9-844c-e9f192c97745"));
+                        em.persist(new SubjectMap(p,
+                            "b0f7b98e-ec1e-4cf9-844c-e9f192c97745"));
                         break;
                     case "coi@unreal.not.email":
-                        em.persist(new SubjectMap(p, "33767eee-35a1-4fef-b32a-f9b6fa6b36e6"));
+                        em.persist(new SubjectMap(p,
+                            "33767eee-35a1-4fef-b32a-f9b6fa6b36e6"));
                         break;
                     default:
                         //do nothing