Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": ["next/core-web-vitals", "next/typescript"]
}
100 changes: 100 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
# Reference: https://github.com/actions/starter-workflows/blob/main/pages/nextjs.yml

# Sample workflow for building and deploying a Next.js site to GitHub Pages
#
# To get started with Next.js see: https://nextjs.org/docs/getting-started
#
name: Deploy Next.js site to Pages

on:
# When a commit is made to the main branch
push:
branches:
- main

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Detect package manager
id: detect-package-manager
run: |
if [ -f "${{ github.workspace }}/yarn.lock" ]; then
echo "manager=yarn" >> $GITHUB_OUTPUT
echo "command=install" >> $GITHUB_OUTPUT
echo "runner=yarn" >> $GITHUB_OUTPUT
exit 0
elif [ -f "${{ github.workspace }}/package.json" ]; then
echo "manager=npm" >> $GITHUB_OUTPUT
echo "command=ci" >> $GITHUB_OUTPUT
echo "runner=npx --no-install" >> $GITHUB_OUTPUT
exit 0
else
echo "Unable to determine package manager"
exit 1
fi

- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: "lts/*"
cache: ${{ steps.detect-package-manager.outputs.manager }}

- name: Setup Pages
uses: actions/configure-pages@v4

- name: Restore cache
uses: actions/cache@v4
with:
path: |
.next/cache
# Generate a new cache whenever packages or source files change.
key: ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-${{ hashFiles('**.[jt]s', '**.[jt]sx') }}
# If source files changed but packages didn't, rebuild from a prior cache.
restore-keys: |
${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-

- name: Install dependencies
run: ${{ steps.detect-package-manager.outputs.manager }} ${{ steps.detect-package-manager.outputs.command }}

- name: Build with Next.js
run: ${{ steps.detect-package-manager.outputs.runner }} next build

- name: Add .nojekyll to out directory
run: touch out/.nojekyll

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./out

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
6 changes: 4 additions & 2 deletions .github/workflows/fetch-ci-nightly-data.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ run-name: Fetch CI Nightly Data
on:
schedule:
- cron: '0 4 * * *'
workflow_dispatch:

jobs:
fetch-and-commit-data:
runs-on: ubuntu-22.04
Expand All @@ -13,7 +15,7 @@ jobs:
- name: Update dashboard data
run: |
# fetch ci nightly data as temporary file
node js/fetch-ci-nightly-data.js | tee tmp-data.js
node scripts/fetch-ci-nightly-data.js | tee tmp-data.json
# switch to a branch specifically for holding latest data
git config --global user.name "GH Actions Workflow"
git config --global user.email "<gha@runner>"
Expand All @@ -23,7 +25,7 @@ jobs:
git reset HEAD~1
# overwrite the old data
mkdir -p data/
mv tmp-data.js data/ci-nightly-data.js
mv tmp-data.json data/job_stats.json
# commit
git add data
git commit -m '[skip ci] latest ci nightly data'
Expand Down
41 changes: 39 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,39 @@
_site/
*.swp
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js
.yarn/install-state.gz

# testing
/coverage

# next.js
/.next/
/out/

# production
/build

# misc
.DS_Store
*.pem
.vscode/*

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# local env files
.env*.local

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts

/job_stats.json
101 changes: 101 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
# Kata Containers Test Dashboard

This repository contains the **Kata Containers Test Dashboard**, a web application that visualizes data for the nightly tests run by the Kata Containers repository. Built using **Next.js** and styled with **TailwindCSS**, this dashboard provides a simple and efficient interface to monitor test results, leveraging modern frontend technologies to ensure responsive and scalable performance.

## Features
- Fetches nightly CI test data using custom scripts.
- Displays weather-like icons to reflect test statuses (e.g., sunny for success, stormy for failures).
- Utilizes **Next.js** for server-side rendering and optimized builds.
- **TailwindCSS** for responsive, utility-first styling.
- Integration of **PrimeReact** components for UI elements.

---

## Project Structure

```bash
.
├── next.config.js # Next.js configuration
├── package.json # Project dependencies and scripts
├── package-lock.json # Dependency lock file
├── pages
│ ├── _app.js # Application wrapper for global setup
│ └── index.js # Main dashboard page
├── postcss.config.js # PostCSS configuration for TailwindCSS
├── public
│ ├── cloudy.svg # Weather icons for test statuses
│ ├── favicon.ico
│ ├── partially-sunny.svg
│ ├── rainy.svg
│ ├── stormy.svg
│ └── sunny.svg
├── README.md # Project documentation (this file)
├── scripts
│ └── fetch-ci-nightly-data.js # Script to fetch nightly test data
├── styles
│ └── globals.css # Global CSS imports
└── tailwind.config.js # TailwindCSS configuration
```

### Key Files
- **`pages/index.js`**: The main entry point of the dashboard, displaying test results and their statuses.
- **`scripts/fetch-ci-nightly-data.js`**: Custom script to retrieve CI data for the dashboard.
- **`styles/globals.css`**: Custom global styles, mainly extending the TailwindCSS base.
- **`public/`**: Contains static assets like icons representing different test statuses.

---

## Setup Instructions

Follow these steps to set up the development environment for the Kata Containers Test Dashboard:

### Prerequisites
- [**Node.js**](https://nodejs.org/en/download) (version 18.x or later recommended)
- **npm** (comes with Node.js)

### Installation

1. **Clone the repository**:
```bash
git clone https://github.com/kata-containers/kata-containers.github.io.git
cd kata-containers.github.io
```

2. **Install dependencies**:
Run the following command to install both the project dependencies and development dependencies.
```bash
npm install
```

### Development

3. **Run the development server**:
Start the Next.js development server with hot-reloading enabled.
```bash
node scripts/fetch-ci-nightly-data.js > job_stats.json
npm run dev
```

The app will be available at [http://localhost:3000](http://localhost:3000).

### Production

4. **Build for production**:
To create an optimized production build, run:
```bash
npm run build
```

5. **Start the production server**:
After building, you can start the server:
```bash
npm start
```

### Scripts

- **Fetch CI Nightly Data**:
The `fetch-ci-nightly-data.js` script can be executed manually to pull the latest CI test data from the Kata Containers repository:
```bash
node scripts/fetch-ci-nightly-data.js > job_stats.json
```
50 changes: 50 additions & 0 deletions components/weatherTemplate.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
import Image from "next/image";
import { basePath } from "../next.config.js";

const icons = [
"sunny.svg",
"partially-sunny.svg",
"cloudy.svg",
"rainy.svg",
"stormy.svg",
];

export const getWeatherIndex = (stat) => {
let fail_rate = 0;
fail_rate = (stat["fails"] + stat["skips"]) / stat["runs"];
// e.g. failing 3/9 runs is .33, or idx=1
var idx = Math.floor((fail_rate * 10) / 2);
if (idx == icons.length) {
// edge case: if 100% failures, then we go past the end of icons[]
// back the idx down by 1
console.assert(fail_rate == 1.0);
idx -= 1;
}

// This error checks if there are zero runs.
// Currently, will display stormy weather.
if (isNaN(idx)) {
idx = 4;
}
return idx;
};

const getWeatherIcon = (stat) => {
const idx = getWeatherIndex(stat);
return icons[idx];
};

export const weatherTemplate = (data) => {
const icon = getWeatherIcon(data);
return (
<div>
<Image
src={`${basePath}/${icon}`}
alt="weather"
width={32}
height={32}
// priority
/>
</div>
);
};
34 changes: 0 additions & 34 deletions index.html

This file was deleted.

Loading
Loading