CI/33 Add dashboard skeleton and integration test

.Rbuildignore

@@ -6,3 +6,4 @@
 ^LICENSE\.md$
 ^\.Rproj\.user$
 ^docker-compose.yml$
+^dashboard_output_dir

.github/workflows/docker.yml

@@ -0,0 +1,30 @@
+---
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - closed
+  push:
+    branches: [main]
+  schedule:
+    - cron: '0 0 * * 1,2,3,4,5'
+  workflow_dispatch:
+
+name: docker
+
+jobs:
+  docker:
+    name: Docker actions
+    uses: RMI-PACTA/actions/.github/workflows/docker.yml@main
+    with:
+      do-check-r-sysdeps: false
+
+  gh-pages:
+    name: gh-pages
+    uses: ./.github/workflows/gh-pages.yml
+    needs: [docker]
+    secrets: inherit
+    with:
+      full-image-name: ${{ needs.docker.outputs.full-image-name }}

.github/workflows/gh-pages.yml

@@ -0,0 +1,109 @@
+name: Deploy to GitHub Pages
+
+on:
+  workflow_call:
+    inputs:
+      full-image-name:
+        required: true
+        type: string
+
+concurrency: preview-${{ github.ref }}
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+      id-token: write
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      # https://github.com/Azure/login?tab=readme-ov-file#login-with-openid-connect-oidc-recommended
+      - name: Azure Login
+        uses: azure/login@v2
+        with:
+          client-id: ${{ secrets.AZURE_CLIENT_ID }}
+          tenant-id: ${{ secrets.AZURE_TENANT_ID }}
+          subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+
+      - name: Download Analysis Outputs
+        id: download-analysis-outputs
+        uses: RMI-PACTA/actions/actions/azure/blob-copy@main
+        with:
+          source: https://pactadatadev.blob.core.windows.net/ghactions-workflow-pacta-results/main/latest/full_params_2023Q4/analysis_output_dir
+          destination: tmp_analysis_output_dir
+
+      - name: Download Benchmarks
+        id: download-benchmarks
+        uses: RMI-PACTA/actions/actions/azure/blob-copy@main
+        with:
+          source: https://pactadatadev.blob.core.windows.net/benchmarks-webapp/2023Q4/2023Q4_20240529T002355Z
+          destination: tmp_benchmarks_dir
+
+      - name: move output and analysis files to correct directory
+        run: |
+          mv tmp_analysis_output_dir/main/latest/full_params_2023Q4/analysis_output_dir analysis_output_dir
+          ls analysis_output_dir
+          mv tmp_benchmarks_dir/2023Q4/2023Q4_20240529T002355Z benchmarks_dir
+          ls benchmarks_dir
+
+      - name: Create Output Directories
+        run: |
+          mkdir -p dashboard_output_dir/data
+
+      - name: Run Docker Image
+        env:
+          FULL_IMAGE_NAME: ${{ inputs.full-image-name }}
+          WORKSPACE: ${{ github.workspace }}
+          PARAMETERS: ""
+          ANALYSIS_OUTPUT_DIR: "analysis_output_dir"
+          BENCHMARKS_DIR: "benchmarks_dir"
+          DASHBOARD_DATA_DIR: "dashboard_output_dir/data"
+          DASHBOARD_OUTPUT_DIR: "dashboard_output_dir"
+        run: |
+
+          docker run \
+          --network none \
+          --user $(id -u):$(id -g) \
+          --env LOG_LEVEL=TRACE \
+          --env ANALYSIS_OUTPUT_DIR="/mnt/analysis_output_dir" \
+          --env BENCHMARKS_DIR="/mnt/benchmarks_dir" \
+          --env DASHBOARD_DATA_DIR="/mnt/dashboard_output_dir/data" \
+          --env DASHBOARD_OUTPUT_DIR="/mnt/dashboard_output_dir" \
+          --mount type=bind,readonly,source=${WORKSPACE}/${BENCHMARKS_DIR},target=/mnt/benchmarks_dir \
+          --mount type=bind,source=${WORKSPACE}/${ANALYSIS_OUTPUT_DIR},target=/mnt/analysis_output_dir \
+          --mount type=bind,source=${WORKSPACE}/${DASHBOARD_OUTPUT_DIR},target=/mnt/dashboard_output_dir \
+          --mount type=bind,source=${WORKSPACE}/${DASHBOARD_DATA_DIR},target=/mnt/dashboard_output_dir/data \
+          $FULL_IMAGE_NAME \
+          "$PARAMETERS"
+
+      - name: chmod & List outputs
+        run: |
+          ls -lR dashboard_output_dir
+
+      - name: Add nojekyll file
+        if: github.event.action != 'closed'
+        run: touch dashboard_output_dir/.nojekyll
+
+      - name: 🚀 Deploy main page
+        if: ${{ github.event_name == 'push' }}
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: dashboard_output_dir # The folder the action should deploy.
+          clean: true
+          force: false
+          clean-exclude: |
+            .nojekyll
+            pr-preview/
+
+      - name: 🛸 Deploy PR preview
+        if: ${{ github.event_name == 'pull_request' }}
+        uses: rossjrw/pr-preview-action@v1
+        with:
+          source-dir: dashboard_output_dir
+          preview-branch: gh-pages
+          umbrella-dir: pr-preview
+          action: auto

.gitignore

@@ -3,4 +3,5 @@
 .Rhistory
 analysis_output_dir/**/*
 benchmarks_dir/**/*
-dashboard_data_dir/**/*
+dashboard_output_dir/**/*
+!dashboard_output_dir/data/.gitkeep

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: workflow.pacta.dashboard
 Title: Run PACTA dashboard JSON generation
-Version: 0.0.0.9004
+Version: 0.0.0.9005
 Authors@R:
     c(person(given = "Alex",
              family = "Axthelm",

Dockerfile

@@ -8,7 +8,9 @@ RUN CRAN_LIKE_URL="https://packagemanager.posit.co/cran/__linux__/jammy/2024-04-
 RUN apt-get update \
     && DEBIAN_FRONTEND="noninteractive" \
     apt-get install -y --no-install-recommends \
-    git=1:2.34.*
+      git=1:2.34.* \
+    && chmod -R a+rwX /root \
+    && rm -rf /var/lib/apt/lists/*
 
 # install pak
 RUN Rscript -e "install.packages('pak', repos = 'https://r-lib.github.io/p/pak/stable/')"
@@ -21,6 +23,9 @@ RUN Rscript -e "pak::local_install_deps('/workflow.pacta.dashboard')"
 
 FROM base AS install-pacta
 
+ENV DASHBOARD_SKELETON_FILES_DIR="/mnt/dashboard_skeleton_files"
+COPY --from=ghcr.io/rmi-pacta/pacta-dashboard-svelte:main /app/build $DASHBOARD_SKELETON_FILES_DIR/
+
 COPY . /workflow.pacta.dashboard/
 
 RUN Rscript -e "pak::local_install(root = '/workflow.pacta.dashboard')"

R/build_dashboard.R

@@ -0,0 +1,33 @@
+build_dashboard <- function(
+  params,
+  analysis_output_dir = Sys.getenv("ANALYSIS_OUTPUT_DIR"),
+  benchmarks_dir = Sys.getenv("BENCHMARKS_DIR"),
+  dashboard_data_dir = Sys.getenv("DASHBOARD_DATA_DIR"),
+  dashboard_skeleton_files_dir = Sys.getenv("DASHBOARD_SKELETON_FILES_DIR"),
+  dashboard_output_dir = Sys.getenv("DASHBOARD_OUTPUT_DIR")
+) {
+
+  prepare_pacta_dashboard_data(
+    analysis_output_dir = analysis_output_dir,
+    dashboard_data_dir = dashboard_data_dir,
+    benchmarks_dir = benchmarks_dir
+  )
+
+  dashboard_copy_success <- copy_dashboard_files(
+    dashboard_skeleton_files_dir = dashboard_skeleton_files_dir,
+    dashboard_output_dir = dashboard_output_dir
+  )
+
+  dashboard_output_data_dir <- file.path(dashboard_output_dir, "data")
+  if (dashboard_data_dir != dashboard_output_data_dir) {
+    if (!dir.exists(dashboard_output_data_dir)) {
+      dir.create(dashboard_output_data_dir, recursive = TRUE)
+    }
+    data_copy_success <- file.copy(
+      from = dashboard_data_dir,
+      to = dashboard_output_data_dir,
+      recursive = TRUE
+    )
+  }
+
+}

R/copy_dashboard_files.R

@@ -0,0 +1,19 @@
+copy_dashboard_files <- function(
+  dashboard_skeleton_files_dir = Sys.getenv("DASHBOARD_SKELETON_FILES_DIR"),
+  dashboard_output_dir = Sys.getenv("DASHBOARD_OUTPUT_DIR")
+) {
+
+  dashboard_files <- list.files(
+    dashboard_skeleton_files_dir,
+    full.names = TRUE,
+    recursive = FALSE
+  )
+
+  dashboard_copy_success <- file.copy(
+    from = dashboard_files,
+    to = file.path(dashboard_output_dir),
+    recursive = TRUE
+  )
+
+  return(all(dashboard_copy_success))
+}

R/prepare_pacta_dashboard_data.R

@@ -342,7 +342,8 @@ prep_key_bars_portfolio(
 
 
 # put JSON and CSV outputs into a zip archive ----------------------------------
-zip_outputs(output_dir)
+
+# zip_outputs(output_dir)
 
 }
 

docker-compose.yml

@@ -11,7 +11,8 @@ services:
       LOG_LEVEL: TRACE
       ANALYSIS_OUTPUT_DIR: "/mnt/analysis_output_dir"
       BENCHMARKS_DIR: "/mnt/benchmarks_dir"
-      DASHBOARD_DATA_DIR: "/mnt/dashboard_data_dir"
+      DASHBOARD_DATA_DIR: "/mnt/dashboard_output_dir/data"
+      DASHBOARD_OUTPUT_DIR: "/mnt/dashboard_output_dir"
     volumes:
       - type: bind
         source: ${benchmarks_dir:-./benchmarks_dir}
@@ -22,6 +23,23 @@ services:
         target: /mnt/analysis_output_dir
         read_only: true
       - type: bind
-        source: ${dashboard_data_dir:-./dashboard_data_dir}
-        target: /mnt/dashboard_data_dir
+        source: ${dashboard_data_dir:-./dashboard_output_dir/data}
+        target: /mnt/dashboard_output_dir/data
         read_only: false
+      - type: bind
+        source: ${dashboard_output_dir:-./dashboard_output_dir}
+        target: /mnt/dashboard_output_dir
+        read_only: false
+
+  server:
+    image: nginx:alpine
+    ports:
+      - 3000:80
+    volumes:
+      - type: bind
+        source: ${dashboard_output_dir:-./dashboard_output_dir}
+        target: /usr/share/nginx/html
+        read_only: false
+    depends_on:
+      workflow.pacta.dashboard:
+        condition: service_completed_successfully # build-app acts as an init container

inst/extdata/scripts/prepare_dashboard_data.R

@@ -18,7 +18,7 @@
 #   force_array = c("portfolio", "files")
 # )
 
-manifest_info <- workflow.pacta.dashboard:::prepare_pacta_dashboard_data(
+manifest_info <- workflow.pacta.dashboard:::build_dashboard(
   # params = params
 )