forked from Hithomelabs/CFTunnels
Compare commits
76 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 48cd8d242f | |||
| b9c39ad990 | |||
| 3de734dbc5 | |||
| 52f40e3d92 | |||
| 3bffa43d6a | |||
| 63660928c9 | |||
| f1c9965396 | |||
| d7a2af9928 | |||
| 2dc1ac17f1 | |||
| 03c509c597 | |||
| 9e35d730f4 | |||
| 0df22454a3 | |||
| c9dea2a91d | |||
| 8ee2abdbd7 | |||
| 35db41573a | |||
| bf5c9f1650 | |||
| bd2d32fa8c | |||
| a3a3917fc0 | |||
| cd270084ad | |||
| 634794e7d3 | |||
| b09386beee | |||
| dbfb49f5a9 | |||
| bfed3d220b | |||
| 8f4af5e322 | |||
| 8e02a9fcd0 | |||
| da2db99755 | |||
| 07b70e633d | |||
| 9e960ea7c0 | |||
| 145597b8bd | |||
| d27176a7d5 | |||
| 3c47643cd4 | |||
| 93e9baa5d4 | |||
| d0e1ea938f | |||
| 76dd43c7b2 | |||
| 21e67dadea | |||
| 5ea62d6baf | |||
| cf24922bb4 | |||
| 62fd2ea48a | |||
| 9e3207dc30 | |||
| f3652611ec | |||
| 6fc44a6969 | |||
| e515532d99 | |||
| 9fb4c4fb14 | |||
| 040c0e9b09 | |||
| d500a8b276 | |||
| 4a3e2777db | |||
| 4abec13ec4 | |||
| 0c6944685f | |||
| ee1762711d | |||
| 0c2e186ba7 | |||
| 2a6e7c176c | |||
| 32083f6ceb | |||
| fa714ef498 | |||
| 02736e43f7 | |||
| 9899e2648b | |||
| 705140629b | |||
| 5ad6acbd00 | |||
| c6d9b0994d | |||
| 29b767d634 | |||
| 6304c69577 | |||
| 7fdfdacf50 | |||
| e4a51ed9f8 | |||
| 047433fe60 | |||
| d728504aad | |||
| 4460e86776 | |||
| ac2ae0a59f | |||
| 258c09285e | |||
| 7e5d20e8ac | |||
| 4197e645cd | |||
| df7ea9a2df | |||
| c6b466530f | |||
| e8f158aece | |||
| a7e7ea4a39 | |||
| e8d535efda | |||
| 6bf138ea7a | |||
| b2ac418ae5 |
@ -2,3 +2,4 @@ CLOUDFLARE_ACCOUNT_ID="<cloudflare account id>"
|
||||
CLOUDFLARE_API_KEY="<cloudflare account key>"
|
||||
CLOUDFLARE_EMAIL="<cloudflare email>"
|
||||
ENV="<deployment env>"
|
||||
MGMT_PORT="5003"
|
||||
138
.gitea/workflows/cftunnels_build_push.yml
Normal file
138
.gitea/workflows/cftunnels_build_push.yml
Normal file
@ -0,0 +1,138 @@
|
||||
name: Build & Push CFTunnels
|
||||
run-name: CF Build started by ${{ gitea.actor }}
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- test # → PATCH bump, build & tag as test
|
||||
- main # → MINOR bump, promote test→prod
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
version:
|
||||
runs-on: ubuntu-latest
|
||||
outputs:
|
||||
new_version: ${{ steps.semver.outputs.new_version }}
|
||||
target_env: ${{ steps.env.outputs.target_env }}
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Determine environment
|
||||
id: env
|
||||
run: |
|
||||
[[ "${{ github.ref_name }}" == "main" ]] && ENV="prod" || ENV="${{ github.ref_name }}"
|
||||
if [[ "$ENV" != "test" && "$ENV" != "prod" ]]; then
|
||||
echo "→ Invalid environment: $ENV. Must be 'test' or 'prod'."
|
||||
exit 1
|
||||
fi
|
||||
echo "target_env=$ENV" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Calculate semver bump
|
||||
id: semver
|
||||
run: |
|
||||
VERSION=$(git describe --tags --match "cf-*" --abbrev=0 2>/dev/null || echo "cf-0.0.0")
|
||||
echo "Latest tag: ${VERSION}"
|
||||
# Strip cf- prefix
|
||||
VERSION=${VERSION#cf-}
|
||||
MAJOR=$(echo ${VERSION} | cut -d "." -f 1)
|
||||
MINOR=$(echo ${VERSION} | cut -d "." -f 2)
|
||||
PATCH=$(echo ${VERSION} | cut -d "." -f 3)
|
||||
|
||||
if [[ "${{ steps.env.outputs.target_env }}" == "prod" ]]; then
|
||||
# MINOR bump, reset PATCH
|
||||
NEW_MINOR=$((MINOR + 1))
|
||||
NEW_VERSION="${MAJOR}.${NEW_MINOR}.0"
|
||||
echo "Production → minor bump: ${NEW_VERSION}"
|
||||
else
|
||||
# test → PATCH bump
|
||||
NEW_PATCH=$((PATCH + 1))
|
||||
NEW_VERSION="${MAJOR}.${MINOR}.${NEW_PATCH}"
|
||||
echo "Test → patch bump: ${NEW_VERSION}"
|
||||
fi
|
||||
echo "new_version=cf-${NEW_VERSION}" >> $GITHUB_OUTPUT
|
||||
|
||||
build-and-push:
|
||||
runs-on: ubuntu-latest
|
||||
needs: version
|
||||
container:
|
||||
image: 192.168.0.100:8928/hithomelabs/ci-runner:1.0.0
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Install JDK (Alpine package)
|
||||
run: |
|
||||
apk add --no-cache openjdk17-jdk
|
||||
echo "JAVA_HOME=/usr/lib/jvm/java-17-openjdk" >> "$GITHUB_ENV"
|
||||
|
||||
- name: Validate Gradle Wrapper (offline checksum)
|
||||
run: |
|
||||
sha256sum --check gradle/wrapper/gradle-wrapper.jar.sha256
|
||||
|
||||
- name: Create and push git tag
|
||||
run: |
|
||||
echo "New version: ${{ needs.version.outputs.new_version }}"
|
||||
git config --global user.name "${{ gitea.actor }}"
|
||||
git config --global user.email "${{ gitea.actor }}@users.noreply.github.com"
|
||||
git tag -a "${{ needs.version.outputs.new_version }}" \
|
||||
-m "Push CF version ${{ needs.version.outputs.new_version }}"
|
||||
git push origin "${{ needs.version.outputs.new_version }}"
|
||||
|
||||
- name: Log in to Gitea Docker Registry
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: 'http://192.168.0.100:8928'
|
||||
username: hitanshu
|
||||
password: ${{ secrets.TOKEN }}
|
||||
|
||||
- name: Build image (test) or promote (prod)
|
||||
run: |
|
||||
ENV="${{ needs.version.outputs.target_env }}"
|
||||
VER="${{ needs.version.outputs.new_version }}"
|
||||
REG="192.168.0.100:8928/hithomelabs/cftunnels"
|
||||
|
||||
if [[ "$ENV" == "test" ]]; then
|
||||
echo "→ Building fresh image for test"
|
||||
./gradlew :cftunnels-service:bootBuildImage --imageName="${REG}:${VER}"
|
||||
docker tag "${REG}:${VER}" "${REG}:test"
|
||||
docker push "${REG}:test"
|
||||
docker push "${REG}:${VER}"
|
||||
else
|
||||
echo "→ Promoting test image to prod"
|
||||
docker pull "${REG}:test"
|
||||
docker tag "${REG}:test" "${REG}:${VER}"
|
||||
docker tag "${REG}:${VER}" "${REG}:prod"
|
||||
docker push "${REG}:prod"
|
||||
docker push "${REG}:${VER}"
|
||||
fi
|
||||
|
||||
- name: Set Portainer deploy variables
|
||||
id: portainer-vars
|
||||
run: |
|
||||
ENV="${{ needs.version.outputs.target_env }}"
|
||||
if [[ "$ENV" == "prod" ]]; then
|
||||
echo "url=http://192.168.0.100:8082" >> $GITHUB_OUTPUT
|
||||
echo "stack=${{ vars.CFTUNNELS_PROD_STACK_ID }}" >> $GITHUB_OUTPUT
|
||||
echo "key=${{ secrets.PORTAINER_SERVICE_API_KEY_PROD }}" >> $GITHUB_OUTPUT
|
||||
else
|
||||
echo "url=http://192.168.0.100:8081" >> $GITHUB_OUTPUT
|
||||
echo "stack=${{ vars.CFTUNNELS_DEV_STACK_ID }}" >> $GITHUB_OUTPUT
|
||||
echo "key=${{ secrets.PORTAINER_SERVICE_API_KEY }}" >> $GITHUB_OUTPUT
|
||||
fi
|
||||
|
||||
- name: Trigger Portainer Redeploy
|
||||
if: success()
|
||||
env:
|
||||
PORTAINER_AUTOMATION_URL: ${{ steps.portainer-vars.outputs.url }}
|
||||
STACK_ID: ${{ steps.portainer-vars.outputs.stack }}
|
||||
API_KEY: ${{ steps.portainer-vars.outputs.key }}
|
||||
run: |
|
||||
wget -q --no-check-certificate --timeout=30 \
|
||||
--post-data= \
|
||||
--header="X-API-Key: $API_KEY" \
|
||||
-O - \
|
||||
"$PORTAINER_AUTOMATION_URL/api/deploy/$STACK_ID" 2>&1 \
|
||||
|| echo "Deploy trigger failed (non-fatal)"
|
||||
110
.gitea/workflows/portainer_automation_build_push.yml
Normal file
110
.gitea/workflows/portainer_automation_build_push.yml
Normal file
@ -0,0 +1,110 @@
|
||||
name: Build & Push Portainer Automation
|
||||
run-name: PA Build started by ${{ gitea.actor }}
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- test # → PATCH bump, build & tag as test
|
||||
- main # → MINOR bump, promote test→prod
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
version:
|
||||
runs-on: ubuntu-latest
|
||||
outputs:
|
||||
new_version: ${{ steps.semver.outputs.new_version }}
|
||||
target_env: ${{ steps.env.outputs.target_env }}
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Determine environment
|
||||
id: env
|
||||
run: |
|
||||
[[ "${{ github.ref_name }}" == "main" ]] && ENV="prod" || ENV="${{ github.ref_name }}"
|
||||
if [[ "$ENV" != "test" && "$ENV" != "prod" ]]; then
|
||||
echo "→ Invalid environment: $ENV. Must be 'test' or 'prod'."
|
||||
exit 1
|
||||
fi
|
||||
echo "target_env=$ENV" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Calculate semver bump
|
||||
id: semver
|
||||
run: |
|
||||
VERSION=$(git describe --tags --match "pa-*" --abbrev=0 2>/dev/null || echo "pa-0.0.0")
|
||||
echo "Latest tag: ${VERSION}"
|
||||
# Strip pa- prefix
|
||||
VERSION=${VERSION#pa-}
|
||||
MAJOR=$(echo ${VERSION} | cut -d "." -f 1)
|
||||
MINOR=$(echo ${VERSION} | cut -d "." -f 2)
|
||||
PATCH=$(echo ${VERSION} | cut -d "." -f 3)
|
||||
|
||||
if [[ "${{ steps.env.outputs.target_env }}" == "prod" ]]; then
|
||||
# MINOR bump, reset PATCH
|
||||
NEW_MINOR=$((MINOR + 1))
|
||||
NEW_VERSION="${MAJOR}.${NEW_MINOR}.0"
|
||||
echo "Production → minor bump: ${NEW_VERSION}"
|
||||
else
|
||||
# test → PATCH bump
|
||||
NEW_PATCH=$((PATCH + 1))
|
||||
NEW_VERSION="${MAJOR}.${MINOR}.${NEW_PATCH}"
|
||||
echo "Test → patch bump: ${NEW_VERSION}"
|
||||
fi
|
||||
echo "new_version=pa-${NEW_VERSION}" >> $GITHUB_OUTPUT
|
||||
|
||||
build-and-push:
|
||||
runs-on: ubuntu-latest
|
||||
needs: version
|
||||
container:
|
||||
image: 192.168.0.100:8928/hithomelabs/ci-runner:1.0.0
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Install JDK (Alpine package)
|
||||
run: |
|
||||
apk add --no-cache openjdk17-jdk
|
||||
echo "JAVA_HOME=/usr/lib/jvm/java-17-openjdk" >> "$GITHUB_ENV"
|
||||
|
||||
- name: Validate Gradle Wrapper (offline checksum)
|
||||
run: |
|
||||
sha256sum --check gradle/wrapper/gradle-wrapper.jar.sha256
|
||||
|
||||
- name: Create and push git tag
|
||||
run: |
|
||||
echo "New version: ${{ needs.version.outputs.new_version }}"
|
||||
git config --global user.name "${{ gitea.actor }}"
|
||||
git config --global user.email "${{ gitea.actor }}@users.noreply.github.com"
|
||||
git tag -a "${{ needs.version.outputs.new_version }}" \
|
||||
-m "Push PA version ${{ needs.version.outputs.new_version }}"
|
||||
git push origin "${{ needs.version.outputs.new_version }}"
|
||||
|
||||
- name: Log in to Gitea Docker Registry
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: 'http://192.168.0.100:8928'
|
||||
username: hitanshu
|
||||
password: ${{ secrets.TOKEN }}
|
||||
|
||||
- name: Build image (test) or promote (prod)
|
||||
run: |
|
||||
ENV="${{ needs.version.outputs.target_env }}"
|
||||
VER="${{ needs.version.outputs.new_version }}"
|
||||
REG="192.168.0.100:8928/hithomelabs/portainer-automation"
|
||||
|
||||
if [[ "$ENV" == "test" ]]; then
|
||||
echo "→ Building fresh image for test"
|
||||
./gradlew :portainer-automation:bootBuildImage --imageName="${REG}:${VER}"
|
||||
docker tag "${REG}:${VER}" "${REG}:test"
|
||||
docker push "${REG}:test"
|
||||
docker push "${REG}:${VER}"
|
||||
else
|
||||
echo "→ Promoting test image to prod"
|
||||
docker pull "${REG}:test"
|
||||
docker tag "${REG}:test" "${REG}:${VER}"
|
||||
docker tag "${REG}:${VER}" "${REG}:prod"
|
||||
docker push "${REG}:prod"
|
||||
docker push "${REG}:${VER}"
|
||||
fi
|
||||
@ -1,57 +0,0 @@
|
||||
name: Promote image with tag test to prod
|
||||
run-name: Build started by $ {{gitea.actor}}
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
jobs:
|
||||
tag:
|
||||
runs-on: ubuntu-latest
|
||||
outputs:
|
||||
new_version: ${{ steps.new_version.outputs.new_version }}
|
||||
steps:
|
||||
- name: Check out repository code
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Get new version
|
||||
id: new_version
|
||||
run: |
|
||||
VERSION=$(git describe --tags --abbrev=0)
|
||||
echo ${VERSION}
|
||||
MAJOR=$(echo ${VERSION} | cut -d "." -f 1)
|
||||
MINOR=$(echo ${VERSION} | cut -d "." -f 2)
|
||||
PATCH=0
|
||||
NEW_MINOR=$(( ${MINOR} + 1))
|
||||
echo ${NEW_MINOR}
|
||||
echo "new_version=$(echo "${MAJOR}.${NEW_MINOR}.${PATCH}")" >> $GITHUB_OUTPUT
|
||||
build_tag_push:
|
||||
runs-on: ubuntu-latest
|
||||
needs: tag
|
||||
container:
|
||||
image: 192.168.0.100:8928/hithomelabs/ci-runner:1.0.0
|
||||
steps:
|
||||
- name: Check out repository code
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Create and push tag
|
||||
run: |
|
||||
echo "NEW_VERSION=${{ needs.tag.outputs.new_version }}"
|
||||
git config --global user.name "${{gitea.actor}}"
|
||||
git config --global user.email "${{ gitea.actor }}@users.noreply.github.com"
|
||||
git tag -a ${{ needs.tag.outputs.new_version }} -m "Pushing new version ${{ needs.tag.outputs.new_version }}"
|
||||
git push origin ${{ needs.tag.outputs.new_version }}
|
||||
- name: Log in to Gitea Docker Registry
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: 'http://192.168.0.100:8928'
|
||||
username: hitanshu
|
||||
password: ${{ secrets.TOKEN }}
|
||||
- name: Tag prod image
|
||||
run: |
|
||||
docker tag 192.168.0.100:8928/hithomelabs/cftunnels:test 192.168.0.100:8928/hithomelabs/cftunnels:${{ needs.tag.outputs.new_version }}
|
||||
docker tag 192.168.0.100:8928/hithomelabs/cftunnels:${{ needs.tag.outputs.new_version }} 192.168.0.100:8928/hithomelabs/cftunnels:prod
|
||||
- name: Push to Gitea Registry
|
||||
run: |
|
||||
docker push 192.168.0.100:8928/hithomelabs/cftunnels:prod
|
||||
docker push 192.168.0.100:8928/hithomelabs/cftunnels:${{ needs.tag.outputs.new_version }}
|
||||
@ -14,7 +14,8 @@ jobs:
|
||||
with:
|
||||
distribution: 'zulu'
|
||||
java-version: '17'
|
||||
- name: Validate Gradle Wrapper
|
||||
uses: gradle/actions/wrapper-validation@v3
|
||||
- name: Validate Gradle Wrapper (offline checksum)
|
||||
run: |
|
||||
sha256sum --check gradle/wrapper/gradle-wrapper.jar.sha256
|
||||
- name: Gradle build
|
||||
run: ./gradlew build --info
|
||||
@ -1,66 +0,0 @@
|
||||
name: sample gradle build and test
|
||||
run-name: Build started by ${{ gitea.actor }}
|
||||
on:
|
||||
push:
|
||||
branches: [test]
|
||||
jobs:
|
||||
tag:
|
||||
runs-on: ubuntu-latest
|
||||
outputs:
|
||||
new_version: ${{ steps.new_version.outputs.new_version }}
|
||||
steps:
|
||||
- name: Check out repository code
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Get new version
|
||||
id: new_version
|
||||
run: |
|
||||
VERSION=$(git describe --tags --abbrev=0)
|
||||
echo "Current version: ${VERSION}"
|
||||
MAJOR=$(echo ${VERSION} | cut -d "." -f 1)
|
||||
MINOR=$(echo ${VERSION} | cut -d "." -f 2)
|
||||
PATCH=$(echo ${VERSION} | cut -d "." -f 3)
|
||||
NEW_PATCH=$((PATCH + 1))
|
||||
NEW_VERSION="${MAJOR}.${MINOR}.${NEW_PATCH}"
|
||||
echo "New version: ${NEW_VERSION}"
|
||||
echo "new_version=${NEW_VERSION}" >> $GITHUB_OUTPUT
|
||||
build_tag_push:
|
||||
runs-on: ubuntu-latest
|
||||
needs: tag
|
||||
container:
|
||||
image: 192.168.0.100:8928/hithomelabs/ci-runner:1.0.0
|
||||
steps:
|
||||
- name: Check out repository code
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Install JDK (Alpine package)
|
||||
run: |
|
||||
apk add --no-cache openjdk17-jdk
|
||||
echo "JAVA_HOME=/usr/lib/jvm/java-17-openjdk" >> "$GITHUB_ENV"
|
||||
- name: Validate Gradle Wrapper
|
||||
uses: gradle/actions/wrapper-validation@v3
|
||||
- name: Create and push tag
|
||||
run: |
|
||||
echo "New version: ${{ needs.tag.outputs.new_version }}"
|
||||
git config --global user.name "${{ gitea.actor }}"
|
||||
git config --global user.email "${{ gitea.actor }}@users.noreply.github.com"
|
||||
git tag -a "${{ needs.tag.outputs.new_version }}" -m "Pushing new version ${{ needs.tag.outputs.new_version }}"
|
||||
git push origin "${{ needs.tag.outputs.new_version }}"
|
||||
- name: Log in to Gitea Docker Registry
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: 'http://192.168.0.100:8928'
|
||||
username: hitanshu
|
||||
password: ${{ secrets.TOKEN }}
|
||||
- name: Gradle build
|
||||
run: ./gradlew bootBuildImage --imageName=192.168.0.100:8928/hithomelabs/cftunnels:${{ needs.tag.outputs.new_version }}
|
||||
- name: Tag image as test
|
||||
run: docker tag 192.168.0.100:8928/hithomelabs/cftunnels:${{ needs.tag.outputs.new_version }} 192.168.0.100:8928/hithomelabs/cftunnels:test
|
||||
- name: Push to Gitea Registry
|
||||
run: |
|
||||
docker push 192.168.0.100:8928/hithomelabs/cftunnels:test
|
||||
docker push 192.168.0.100:8928/hithomelabs/cftunnels:${{ needs.tag.outputs.new_version }}
|
||||
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
@ -6,6 +6,7 @@ build/
|
||||
!gradle/wrapper/gradle-wrapper.jar
|
||||
!**/src/main/**/build/
|
||||
!**/src/test/**/build/
|
||||
CFTunnels/
|
||||
|
||||
### STS ###
|
||||
.apt_generated
|
||||
|
||||
@ -1,4 +0,0 @@
|
||||
FROM openjdk:17-jdk
|
||||
ARG JAR_FILE=target/*.jar
|
||||
COPY ${JAR_FILE} app.jar
|
||||
ENTRYPOINT ["java","-jar","/app.jar"]
|
||||
186
README.md
Normal file
186
README.md
Normal file
@ -0,0 +1,186 @@
|
||||
# CFTunnels - Cloudflare Tunnels Management API
|
||||
|
||||
> **Note**: All pull requests should be raised against the `test` branch.
|
||||
|
||||
A Spring Boot REST API for managing Cloudflare Tunnels with ingress mappings and an approval workflow.
|
||||
|
||||
## Overview
|
||||
|
||||
CFTunnels provides a programmatic way to manage Cloudflare Tunnel configurations, allowing teams to:
|
||||
|
||||
- View and manage Cloudflare Tunnels
|
||||
- Add, modify, and delete ingress mappings
|
||||
- Request mapping changes through an approval workflow
|
||||
- Track tunnel configurations locally
|
||||
|
||||
## Features
|
||||
|
||||
- **Tunnel Management**: Create, update, and delete Cloudflare tunnels
|
||||
- **Ingress Mappings**: Add custom ingress rules to tunnel configurations
|
||||
- **Approval Workflow**: Request/approve/reject mapping changes
|
||||
- **Security**: OIDC-based authentication with role-based access
|
||||
- **API Documentation**: OpenAPI/Swagger documentation
|
||||
|
||||
## Technology Stack
|
||||
|
||||
- Java 17
|
||||
- Spring Boot 3.x
|
||||
- Spring Data JPA
|
||||
- Spring Security with OIDC
|
||||
- H2 Database (configurable for PostgreSQL)
|
||||
- Cloudflare API v4
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Java 17 or higher
|
||||
- Cloudflare account with API key
|
||||
- OIDC provider (e.g., Google, Okta, Auth0)
|
||||
|
||||
## Configuration
|
||||
|
||||
Copy `.env.example` to `.env` and configure:
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
### Required Environment Variables
|
||||
|
||||
| Variable | Description |
|
||||
|---------|-------------|
|
||||
| `CLOUDFLARE_ACCOUNT_ID` | Cloudflare Account ID |
|
||||
| `CLOUDFLARE_API_KEY` | Cloudflare API Key |
|
||||
| `CLOUDFLARE_EMAIL` | Cloudflare account email |
|
||||
| `SPRING_PROFILES_ACTIVE` | Environment (local, dev, prod) |
|
||||
|
||||
### Security Configuration
|
||||
|
||||
OIDC settings in `application.properties`:
|
||||
|
||||
```properties
|
||||
spring.security.oauth2.client.registration.<provider>.client-id=your-client-id
|
||||
spring.security.oauth2.client.registration.<provider>.client-secret=your-client-secret
|
||||
spring.security.oauth2.client.provider.<provider>.issuer-uri=https://your-oidc-provider
|
||||
```
|
||||
|
||||
## Running Locally
|
||||
|
||||
### Using Gradle
|
||||
|
||||
```bash
|
||||
./gradlew bootRun
|
||||
```
|
||||
|
||||
### Using Docker
|
||||
|
||||
```bash
|
||||
docker-compose up --build
|
||||
```
|
||||
|
||||
The API will be available at `http://localhost:8080`
|
||||
|
||||
## API Documentation
|
||||
|
||||
Once running, access:
|
||||
|
||||
- **Swagger UI**: `http://localhost:8080/swagger-ui.html`
|
||||
- **OpenAPI JSON**: `http://localhost:8080/v3/api-docs`
|
||||
|
||||
## API Endpoints
|
||||
|
||||
### Base URL: `/cloudflare`
|
||||
|
||||
| Method | Endpoint | Description | Required Role |
|
||||
|--------|----------|-------------|---------------|
|
||||
| GET | `/whoami` | Get current user info | USER |
|
||||
| GET | `/tunnels` | List all Cloudflare tunnels | USER |
|
||||
| GET | `/configured/tunnels` | List locally configured tunnels | USER |
|
||||
| GET | `/requests` | List all mapping requests | USER |
|
||||
| GET | `/tunnels/{tunnelId}/mappings` | Get tunnel configuration | DEVELOPER |
|
||||
| POST | `/tunnels/{tunnelId}/mappings` | Add ingress mapping | ADMIN |
|
||||
| DELETE | `/tunnels/{tunnelId}/mappings` | Delete ingress mapping | DEVELOPER |
|
||||
| POST | `/tunnels/configure/{tunnelId}/requests` | Create mapping request | DEVELOPER |
|
||||
| PUT | `/requests/{requestId}/approve` | Approve mapping request | APPROVER |
|
||||
| PUT | `/requests/{requestId}/reject` | Reject mapping request | APPROVER |
|
||||
| PUT | `/tunnels/configure/{tunnelId}` | Configure tunnel for environment | ADMIN |
|
||||
|
||||
## Role-Based Access
|
||||
|
||||
| Role | Permissions |
|
||||
|------|-------------|
|
||||
| USER | View tunnels and requests |
|
||||
| DEVELOPER | Create/modify/delete mappings, create requests |
|
||||
| APPROVER | Approve/reject requests |
|
||||
| ADMIN | Full access including tunnel configuration |
|
||||
|
||||
## Example Usage
|
||||
|
||||
### List all tunnels
|
||||
|
||||
```bash
|
||||
curl -H "Authorization: Bearer $TOKEN" \
|
||||
http://localhost:8080/cloudflare/tunnels
|
||||
```
|
||||
|
||||
### Add an ingress mapping
|
||||
|
||||
```bash
|
||||
curl -X POST \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"hostname": "api.example.com",
|
||||
"service": "http://localhost:8080",
|
||||
"originRequest": {"noTLSVerify": true}
|
||||
}' \
|
||||
http://localhost:8080/cloudflare/tunnels/{tunnelId}/mappings
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
CFTunnels/
|
||||
├── src/main/java/com/hithomelabs/CFTunnels/
|
||||
│ ├── CfTunnelsApplication.java # Main application
|
||||
│ ├── Config/ # Configuration classes
|
||||
│ ├── Controllers/ # REST controllers
|
||||
│ │ └── TunnelController.java # Main API controller
|
||||
│ ├── Entity/ # JPA entities
|
||||
│ │ ├── Mapping.java # Ingress mapping
|
||||
│ │ ├── Protocol.java # Protocol enum
|
||||
│ │ ├── Request.java # Mapping request
|
||||
│ │ ├── Tunnel.java # Tunnel entity
|
||||
│ │ └── User.java # User entity
|
||||
│ ├── Models/ # DTOs
|
||||
│ ├── Repositories/ # JPA repositories
|
||||
│ └── Services/ # Business logic
|
||||
│ ├── CloudflareAPIService.java # Cloudflare API
|
||||
│ └── MappingRequestService.java # Request workflow
|
||||
└── src/main/resources/
|
||||
├── application.properties # Main config
|
||||
└── schema.sql # Database schema
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
Run tests with:
|
||||
|
||||
```bash
|
||||
./gradlew test
|
||||
```
|
||||
|
||||
Run integration tests:
|
||||
|
||||
```bash
|
||||
./gradlew integrationTest
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
Private - All rights reserved
|
||||
|
||||
## References
|
||||
|
||||
- [Cloudflare Tunnel Documentation](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/)
|
||||
- [Cloudflare API v4](https://api.cloudflare.com/)
|
||||
- [Spring Boot Documentation](https://docs.spring.io/spring-boot/docs/current/reference/)
|
||||
67
build.gradle
67
build.gradle
@ -1,62 +1,29 @@
|
||||
plugins {
|
||||
id 'java'
|
||||
id 'org.springframework.boot' version '3.4.5'
|
||||
id 'io.spring.dependency-management' version '1.1.7'
|
||||
id 'org.springframework.boot' version '3.4.5' apply false
|
||||
id 'io.spring.dependency-management' version '1.1.7' apply false
|
||||
}
|
||||
|
||||
group = 'com.hithomelabs'
|
||||
version = '0.0.1-SNAPSHOT'
|
||||
subprojects {
|
||||
apply plugin: 'java'
|
||||
apply plugin: 'io.spring.dependency-management'
|
||||
|
||||
java {
|
||||
group = 'com.hithomelabs'
|
||||
version = '0.0.1-SNAPSHOT'
|
||||
|
||||
java {
|
||||
toolchain {
|
||||
languageVersion = JavaLanguageVersion.of(17)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
test {
|
||||
systemProperty 'spring.profiles.active', 'ci'
|
||||
useJUnitPlatform {
|
||||
excludeTags 'integration'
|
||||
}
|
||||
testLogging {
|
||||
events "passed", "skipped", "failed", "standardOut", "standardError"
|
||||
exceptionFormat "full" // shows full stack trace
|
||||
showStandardStreams = true // shows println/log output
|
||||
}
|
||||
}
|
||||
|
||||
tasks.register('integrationTestOnly', Test) {
|
||||
useJUnitPlatform {
|
||||
includeTags 'integration'
|
||||
}
|
||||
description = 'Runs only integration tests tagged with @Tag("integration")'
|
||||
group = 'verification'
|
||||
testLogging {
|
||||
events "passed", "skipped", "failed"
|
||||
exceptionFormat "full"
|
||||
showStandardStreams = true
|
||||
}
|
||||
}
|
||||
|
||||
repositories {
|
||||
repositories {
|
||||
mavenCentral()
|
||||
}
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation group: 'org.springdoc', name: 'springdoc-openapi-starter-webmvc-ui', version: '2.8.5'
|
||||
implementation group: 'org.springframework.boot', name:'spring-boot-starter-oauth2-client', version: '3.5.5'
|
||||
compileOnly 'org.projectlombok:lombok:1.18.30'
|
||||
annotationProcessor 'org.projectlombok:lombok:1.18.30'
|
||||
implementation 'org.springframework.boot:spring-boot-starter-web'
|
||||
testImplementation 'org.springframework.boot:spring-boot-starter-test'
|
||||
testImplementation 'org.springframework.security:spring-security-test'
|
||||
testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
|
||||
implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
|
||||
runtimeOnly 'org.postgresql:postgresql'
|
||||
implementation 'org.hibernate.validator:hibernate-validator'
|
||||
runtimeOnly 'com.h2database:h2'
|
||||
}
|
||||
|
||||
tasks.named('test') {
|
||||
useJUnitPlatform()
|
||||
dependencyManagement {
|
||||
imports {
|
||||
mavenBom "org.springframework.boot:spring-boot-dependencies:3.4.5"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
13
cftunnels-service/Dockerfile
Normal file
13
cftunnels-service/Dockerfile
Normal file
@ -0,0 +1,13 @@
|
||||
FROM openjdk:17-jdk as build
|
||||
WORKDIR /app
|
||||
COPY gradlew settings.gradle build.gradle ./
|
||||
COPY gradle ./gradle
|
||||
COPY common ./common
|
||||
COPY cftunnels-service ./cftunnels-service
|
||||
COPY portainer-automation ./portainer-automation
|
||||
RUN ./gradlew :cftunnels-service:bootJar
|
||||
|
||||
FROM openjdk:17-jdk-slim
|
||||
COPY --from=build /app/cftunnels-service/build/libs/*.jar app.jar
|
||||
EXPOSE 8080 8081
|
||||
ENTRYPOINT ["java", "-jar", "/app.jar"]
|
||||
47
cftunnels-service/build.gradle
Normal file
47
cftunnels-service/build.gradle
Normal file
@ -0,0 +1,47 @@
|
||||
apply plugin: 'org.springframework.boot'
|
||||
|
||||
dependencies {
|
||||
implementation project(':common')
|
||||
|
||||
implementation 'org.springframework.boot:spring-boot-starter-web'
|
||||
implementation 'org.springframework.boot:spring-boot-starter-oauth2-client'
|
||||
implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
|
||||
implementation 'org.springframework.boot:spring-boot-starter-security'
|
||||
implementation 'org.springframework.boot:spring-boot-starter-actuator'
|
||||
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.5'
|
||||
implementation 'org.hibernate.validator:hibernate-validator'
|
||||
|
||||
runtimeOnly 'org.postgresql:postgresql'
|
||||
runtimeOnly 'com.h2database:h2'
|
||||
|
||||
compileOnly 'org.projectlombok:lombok'
|
||||
annotationProcessor 'org.projectlombok:lombok'
|
||||
|
||||
testImplementation 'org.springframework.boot:spring-boot-starter-test'
|
||||
testImplementation 'org.springframework.security:spring-security-test'
|
||||
}
|
||||
|
||||
test {
|
||||
systemProperty 'spring.profiles.active', 'ci'
|
||||
useJUnitPlatform {
|
||||
excludeTags 'integration'
|
||||
}
|
||||
testLogging {
|
||||
events "passed", "skipped", "failed", "standardOut", "standardError"
|
||||
exceptionFormat "full"
|
||||
showStandardStreams = true
|
||||
}
|
||||
}
|
||||
|
||||
tasks.register('integrationTestOnly', Test) {
|
||||
useJUnitPlatform {
|
||||
includeTags 'integration'
|
||||
}
|
||||
description = 'Runs only integration tests tagged with @Tag("integration")'
|
||||
group = 'verification'
|
||||
testLogging {
|
||||
events "passed", "skipped", "failed"
|
||||
exceptionFormat "full"
|
||||
showStandardStreams = true
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,47 @@
|
||||
package com.hithomelabs.cftunnels;
|
||||
|
||||
import org.springframework.boot.SpringApplication;
|
||||
import org.springframework.boot.autoconfigure.SpringBootApplication;
|
||||
/**
|
||||
* Main Spring Boot application class for Cloudflare Tunnels API.
|
||||
*
|
||||
* <p>This application provides a RESTful API for managing Cloudflare Tunnels,
|
||||
* allowing users to create tunnel mappings to services with an approval workflow.</p>
|
||||
*
|
||||
* <p><b>Features:</b></p>
|
||||
* <ul>
|
||||
* <li>Create, update, and delete Cloudflare tunnels</li>
|
||||
* <li>Add ingress mappings to tunnels</li>
|
||||
* <li>Request/approval workflow for mapping changes</li>
|
||||
* <li>OIDC-based authentication with role-based access</li>
|
||||
* </ul>
|
||||
*
|
||||
* <p><b>Technology Stack:</b></p>
|
||||
* <ul>
|
||||
* <li>Java 17</li>
|
||||
* <li>Spring Boot 3.x</li>
|
||||
* <li>Spring Data JPA</li>
|
||||
* <li>Spring Security with OIDC</li>
|
||||
* <li>H2 Database (configurable for PostgreSQL)</li>
|
||||
* <li>Cloudflare API</li>
|
||||
* </ul>
|
||||
*
|
||||
* <p>Access the API documentation at:
|
||||
* {@code /swagger-ui.html} for the Swagger/OpenAPI UI</p>
|
||||
*
|
||||
* @see <a href="https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-negative">Cloudflare Tunnel Documentation</a>
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@SpringBootApplication(scanBasePackages = "com.hithomelabs")
|
||||
public class CfTunnelsApplication {
|
||||
|
||||
/**
|
||||
* Main entry point for the application.
|
||||
*
|
||||
* @param args command line arguments passed to the application
|
||||
*/
|
||||
public static void main(String[] args) {
|
||||
SpringApplication.run(CfTunnelsApplication.class, args);
|
||||
}
|
||||
|
||||
}
|
||||
@ -1,7 +1,7 @@
|
||||
package com.hithomelabs.CFTunnels.Config;
|
||||
package com.hithomelabs.cftunnels.Config;
|
||||
|
||||
import com.hithomelabs.CFTunnels.Models.Authorities;
|
||||
import com.hithomelabs.CFTunnels.Models.Groups;
|
||||
import com.hithomelabs.cftunnels.Models.Authorities;
|
||||
import com.hithomelabs.cftunnels.Models.Groups;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.security.core.GrantedAuthority;
|
||||
import org.springframework.security.core.authority.SimpleGrantedAuthority;
|
||||
@ -0,0 +1,58 @@
|
||||
package com.hithomelabs.cftunnels.Config;
|
||||
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
|
||||
/**
|
||||
* Configuration class for Cloudflare API credentials.
|
||||
*
|
||||
* <p>Loads Cloudflare configuration from application properties
|
||||
* using the {@code cloudflare.*} prefix.</p>
|
||||
*
|
||||
* <p><b>Example configuration in application.properties:</b></p>
|
||||
* <pre>
|
||||
* cloudflare.account-id=your-account-id
|
||||
* cloudflare.api-key=your-api-key
|
||||
* cloudflare.email=your@email.com
|
||||
* </pre>
|
||||
*
|
||||
* @see <a href="https://api.cloudflare.com/">Cloudflare API Documentation</a>
|
||||
*/
|
||||
@Configuration
|
||||
@ConfigurationProperties(prefix = "cloudflare")
|
||||
public class CloudflareConfig {
|
||||
|
||||
/**
|
||||
* Cloudflare account ID.
|
||||
*
|
||||
* <p>Found in the Cloudflare Dashboard under
|
||||
* Overview > Account ID</p>
|
||||
*/
|
||||
private String accountId;
|
||||
|
||||
/**
|
||||
* Cloudflare API Key.
|
||||
*
|
||||
* <p>Generated in Cloudflare Dashboard under
|
||||
* Profile > API Tokens > Global API Key</p>
|
||||
*/
|
||||
private String apiKey;
|
||||
|
||||
/**
|
||||
* Cloudflare account email.
|
||||
*
|
||||
* <p>The email address associated with your
|
||||
* Cloudflare account.</p>
|
||||
*/
|
||||
private String email;
|
||||
|
||||
// Getters and Setters
|
||||
public String getAccountId() { return accountId; }
|
||||
public void setAccountId(String accountId) { this.accountId = accountId; }
|
||||
|
||||
public String getApiKey() { return apiKey; }
|
||||
public void setApiKey(String apiKey) { this.apiKey = apiKey; }
|
||||
|
||||
public String getEmail() { return email; }
|
||||
public void setEmail(String email) { this.email = email; }
|
||||
}
|
||||
@ -1,4 +1,4 @@
|
||||
package com.hithomelabs.CFTunnels.Config;
|
||||
package com.hithomelabs.cftunnels.Config;
|
||||
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
@ -1,4 +1,4 @@
|
||||
package com.hithomelabs.CFTunnels.Config;
|
||||
package com.hithomelabs.cftunnels.Config;
|
||||
|
||||
import io.swagger.v3.oas.models.Components;
|
||||
import io.swagger.v3.oas.models.OpenAPI;
|
||||
@ -0,0 +1,39 @@
|
||||
package com.hithomelabs.cftunnels.Config.Security;
|
||||
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.core.Ordered;
|
||||
import org.springframework.core.annotation.Order;
|
||||
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
|
||||
import org.springframework.security.web.SecurityFilterChain;
|
||||
import org.springframework.boot.actuate.autoconfigure.security.servlet.EndpointRequest;
|
||||
|
||||
/**
|
||||
* Security configuration for Spring Boot Actuator endpoints.
|
||||
*
|
||||
* This configuration permits unauthenticated access to /actuator/health and /actuator/info
|
||||
* endpoints, enabling health monitoring by Uptime Kuma without requiring OIDC authentication.
|
||||
* All other actuator endpoints remain protected and require authentication.
|
||||
*
|
||||
* Uses @Order(Ordered.HIGHEST_PRECEDENCE) to ensure this filter chain is evaluated BEFORE
|
||||
* any auto-configured management security filter chains (e.g., ManagementWebSecurityAutoConfiguration).
|
||||
* Without this, the catch-all SecurityFilterChain in SecuirtyConfig can intercept actuator
|
||||
* requests on the separate management port (management.server.port=8081) and redirect to OIDC login.
|
||||
*/
|
||||
@Configuration
|
||||
@Order(Ordered.HIGHEST_PRECEDENCE)
|
||||
public class ActuatorSecurityConfig {
|
||||
|
||||
@Bean
|
||||
public SecurityFilterChain actuatorSecurityChain(HttpSecurity http) throws Exception {
|
||||
http
|
||||
.securityMatcher(EndpointRequest.toAnyEndpoint())
|
||||
.authorizeHttpRequests(auth -> auth
|
||||
.requestMatchers("/actuator/health", "/actuator/info").permitAll()
|
||||
.anyRequest().authenticated()
|
||||
)
|
||||
.csrf(csrf -> csrf.disable());
|
||||
|
||||
return http.build();
|
||||
}
|
||||
}
|
||||
@ -1,6 +1,6 @@
|
||||
package com.hithomelabs.CFTunnels.Config.Security;
|
||||
package com.hithomelabs.cftunnels.Config.Security;
|
||||
|
||||
import com.hithomelabs.CFTunnels.Config.CustomOidcUserConfiguration;
|
||||
import com.hithomelabs.cftunnels.Config.CustomOidcUserConfiguration;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
@ -29,6 +29,7 @@ public class SecuirtyConfig {
|
||||
http
|
||||
.authorizeHttpRequests(auth -> auth
|
||||
//.requestMatchers( "/v3/api-docs/**", "/swagger-ui/**", "/swagger-ui.html" ).permitAll()
|
||||
.requestMatchers("/actuator/health", "/actuator/info").permitAll()
|
||||
.anyRequest().authenticated()
|
||||
).csrf(csrf -> csrf.disable())
|
||||
.with(new OAuth2LoginConfigurer<>(),
|
||||
@ -1,20 +1,20 @@
|
||||
package com.hithomelabs.CFTunnels.Controllers;
|
||||
package com.hithomelabs.cftunnels.Controllers;
|
||||
|
||||
import com.fasterxml.jackson.core.JsonProcessingException;
|
||||
import com.hithomelabs.CFTunnels.Config.AuthoritiesToGroupMapping;
|
||||
import com.hithomelabs.CFTunnels.Config.CloudflareConfig;
|
||||
import com.hithomelabs.CFTunnels.Config.RestTemplateConfig;
|
||||
import com.hithomelabs.CFTunnels.Entity.Request;
|
||||
import com.hithomelabs.CFTunnels.Entity.Tunnel;
|
||||
import com.hithomelabs.CFTunnels.Entity.User;
|
||||
import com.hithomelabs.CFTunnels.Headers.AuthKeyEmailHeader;
|
||||
import com.hithomelabs.CFTunnels.Models.Config;
|
||||
import com.hithomelabs.CFTunnels.Models.Ingress;
|
||||
import com.hithomelabs.CFTunnels.Models.TunnelResponse;
|
||||
import com.hithomelabs.CFTunnels.Models.TunnelsResponse;
|
||||
import com.hithomelabs.CFTunnels.Repositories.UserRepository;
|
||||
import com.hithomelabs.CFTunnels.Services.CloudflareAPIService;
|
||||
import com.hithomelabs.CFTunnels.Services.MappingRequestService;
|
||||
import com.hithomelabs.cftunnels.Config.AuthoritiesToGroupMapping;
|
||||
import com.hithomelabs.cftunnels.Config.CloudflareConfig;
|
||||
import com.hithomelabs.common.config.RestTemplateConfig;
|
||||
import com.hithomelabs.cftunnels.Entity.Request;
|
||||
import com.hithomelabs.cftunnels.Entity.Tunnel;
|
||||
import com.hithomelabs.cftunnels.Entity.User;
|
||||
import com.hithomelabs.cftunnels.Headers.AuthKeyEmailHeader;
|
||||
import com.hithomelabs.cftunnels.Models.Config;
|
||||
import com.hithomelabs.cftunnels.Models.Ingress;
|
||||
import com.hithomelabs.cftunnels.Models.TunnelResponse;
|
||||
import com.hithomelabs.cftunnels.Models.TunnelsResponse;
|
||||
import com.hithomelabs.cftunnels.Repositories.UserRepository;
|
||||
import com.hithomelabs.cftunnels.Services.CloudflareAPIService;
|
||||
import com.hithomelabs.cftunnels.Services.MappingRequestService;
|
||||
import io.swagger.v3.oas.annotations.Operation;
|
||||
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
@ -22,7 +22,6 @@ import org.springframework.beans.factory.annotation.Value;
|
||||
import org.springframework.boot.web.servlet.error.ErrorController;
|
||||
import org.springframework.dao.DataAccessException;
|
||||
import org.springframework.http.*;
|
||||
import org.springframework.http.*;
|
||||
import org.springframework.security.access.prepost.PreAuthorize;
|
||||
import org.springframework.security.core.GrantedAuthority;
|
||||
import org.springframework.security.core.annotation.AuthenticationPrincipal;
|
||||
@ -36,6 +35,41 @@ import java.util.Map;
|
||||
import java.util.NoSuchElementException;
|
||||
import java.util.UUID;
|
||||
|
||||
/**
|
||||
* REST Controller for managing Cloudflare Tunnels.
|
||||
*
|
||||
* <p>This controller provides the public API for managing Cloudflare Tunnels
|
||||
* and their ingress mappings. All endpoints require authentication via OIDC
|
||||
* and are protected by role-based access control.</p>
|
||||
*
|
||||
* <p><b>Base URL:</b> {@code /cloudflare}</p>
|
||||
*
|
||||
* <p><b>Authentication:</b> OIDC-based with role-based access</p>
|
||||
*
|
||||
* <p><b>Available Roles:</b></p>
|
||||
* <ul>
|
||||
* <li>USER - View tunnels and requests</li>
|
||||
* <li>DEVELOPER - Create/modify/delete mappings</li>
|
||||
* <li>APPROVER - Approve/reject requests</li>
|
||||
* <li>ADMIN - Full tunnel configuration access</li>
|
||||
* </ul>
|
||||
*
|
||||
* <p><b>Example Usage:</b></p>
|
||||
* <pre>
|
||||
* # Get all tunnels (requires USER role)
|
||||
* curl -H "Authorization: Bearer <token>" \
|
||||
* https://api.example.com/cloudflare/tunnels
|
||||
*
|
||||
* # Add a mapping (requires ADMIN role)
|
||||
* curl -X POST -H "Authorization: Bearer <token>" \
|
||||
* -H "Content-Type: application/json" \
|
||||
* -d '{"hostname":"api.example.com","service":"http://localhost:8080"}' \
|
||||
* https://api.example.com/cloudflare/tunnels/{tunnelId}/mappings
|
||||
* </pre>
|
||||
*
|
||||
* @see CloudflareAPIService
|
||||
* @see MappingRequestService
|
||||
*/
|
||||
@RestController
|
||||
@RequestMapping("/cloudflare")
|
||||
public class TunnelController implements ErrorController {
|
||||
@ -63,9 +97,21 @@ public class TunnelController implements ErrorController {
|
||||
@Autowired
|
||||
private UserRepository userRepository;
|
||||
|
||||
/**
|
||||
* Current environment (loaded from spring.profiles.active).
|
||||
*/
|
||||
@Value("${spring.profiles.active}")
|
||||
private String environment;
|
||||
|
||||
/**
|
||||
* Get current user information.
|
||||
*
|
||||
* <p>Returns the authenticated user's username and roles.</p>
|
||||
*
|
||||
* @param oidcUser The authenticated OIDC user
|
||||
* @return Map containing username and roles
|
||||
* @throws SecurityException if authentication fails
|
||||
*/
|
||||
@PreAuthorize("hasAnyRole('USER')")
|
||||
@GetMapping("/whoami")
|
||||
public Map<String,Object> whoAmI(@AuthenticationPrincipal OidcUser oidcUser) {
|
||||
@ -79,6 +125,16 @@ public class TunnelController implements ErrorController {
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all tunnels from Cloudflare API.
|
||||
*
|
||||
* <p>Fetches the complete list of tunnels from Cloudflare,
|
||||
* including their status and configuration from the Cloudflare API.</p>
|
||||
*
|
||||
* @return Map containing list of all tunnels
|
||||
* @throws SecurityException if user lacks required role
|
||||
* @see <a href="https://api.cloudflare.com/#cfd_tunnel-get-tunnels">Cloudflare API</a>
|
||||
*/
|
||||
@PreAuthorize("hasAnyRole('USER')")
|
||||
@GetMapping("/tunnels")
|
||||
@Operation( security = { @SecurityRequirement(name = "oidcAuth") } )
|
||||
@ -92,6 +148,16 @@ public class TunnelController implements ErrorController {
|
||||
return ResponseEntity.ok(jsonResponse);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get locally configured tunnels.
|
||||
*
|
||||
* <p>Returns the tunnels that have been configured locally
|
||||
* with environment associations.</p>
|
||||
*
|
||||
* @return Map containing list of configured tunnels
|
||||
* @throws SecurityException if user lacks required role
|
||||
* @see CloudflareAPIService#getAllConfiguredTunnels()
|
||||
*/
|
||||
@PreAuthorize("hasAnyRole('USER')")
|
||||
@GetMapping("/configured/tunnels")
|
||||
public ResponseEntity<Map<String,Object>> getConfiguredTunnels(){
|
||||
@ -106,6 +172,14 @@ public class TunnelController implements ErrorController {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all mapping requests.
|
||||
*
|
||||
* <p>Returns all pending, approved, and rejected mapping requests.</p>
|
||||
*
|
||||
* @return Map containing list of all requests
|
||||
* @throws SecurityException if user lacks required role
|
||||
*/
|
||||
@PreAuthorize("hasAnyRole('USER')")
|
||||
@GetMapping("/requests")
|
||||
public ResponseEntity<Map<String,Object>> getAllRequests() {
|
||||
@ -120,6 +194,17 @@ public class TunnelController implements ErrorController {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get tunnel configuration from Cloudflare.
|
||||
*
|
||||
* <p>Fetches the complete configuration for a specific tunnel,
|
||||
* including all ingress rules.</p>
|
||||
*
|
||||
* @param tunnelId The Cloudflare tunnel ID (UUID)
|
||||
* @return Map containing tunnel configuration
|
||||
* @throws SecurityException if user lacks required role
|
||||
* @see <a href="https://api.cloudflare.com/#cfd_tunnel-get-tunnel-config">Cloudflare API</a>
|
||||
*/
|
||||
@PreAuthorize("hasAnyRole('DEVELOPER')")
|
||||
@GetMapping("/tunnels/{tunnelId}/mappings")
|
||||
public ResponseEntity<Map<String,Object>> getTunnelConfigurations(@PathVariable String tunnelId) {
|
||||
@ -132,22 +217,41 @@ public class TunnelController implements ErrorController {
|
||||
return ResponseEntity.ok(jsonResponse);
|
||||
}
|
||||
|
||||
// 50df9101-f625-4618-b7c5-100338a57124
|
||||
/**
|
||||
* Add an ingress mapping to a tunnel.
|
||||
*
|
||||
* <p>Adds a new ingress rule to the tunnel configuration.
|
||||
* The new rule is inserted at the second-to-last position,
|
||||
* before any catch-all rule.</p>
|
||||
*
|
||||
* @param tunnelId The Cloudflare tunnel ID (UUID)
|
||||
* @param ingress The ingress rule to add
|
||||
* @return Map containing the updated configuration
|
||||
* @throws SecurityException if user lacks required role
|
||||
* @throws JsonProcessingException if JSON processing fails
|
||||
*
|
||||
* @example
|
||||
* {
|
||||
* "hostname": "api.example.com",
|
||||
* "service": "http://localhost:8080",
|
||||
* "originRequest": {"noTLSVerify": true}
|
||||
* }
|
||||
*/
|
||||
@PreAuthorize("hasAnyRole('ADMIN')")
|
||||
@PostMapping("/tunnels/{tunnelId}/mappings")
|
||||
public ResponseEntity<Map<String, Object>> addTunnelconfiguration(@PathVariable String tunnelId, @RequestBody Ingress ingress) throws JsonProcessingException {
|
||||
|
||||
ResponseEntity<TunnelResponse> responseEntity = cloudflareAPIService.getCloudflareTunnelConfigurations(tunnelId, restTemplateConfig.restTemplate(), TunnelResponse.class);
|
||||
|
||||
// * * Inserting new ingress value at second-to last position in list
|
||||
// Inserting new ingress value at second-to last position in list
|
||||
Config config = responseEntity.getBody().getResult().getConfig();
|
||||
List<Ingress> response_ingress = config.getIngress();
|
||||
response_ingress.add(response_ingress.size()-1, ingress);
|
||||
|
||||
// * * Hitting put endpoint
|
||||
// Hitting put endpoint
|
||||
ResponseEntity<TunnelResponse> response = cloudflareAPIService.putCloudflareTunnelConfigurations(tunnelId, restTemplateConfig.restTemplate(), TunnelResponse.class, config);
|
||||
|
||||
// * * Displaying response
|
||||
// Displaying response
|
||||
Map<String, Object> jsonResponse = new HashMap<>();
|
||||
jsonResponse.put("status", response.getStatusCode().toString());
|
||||
jsonResponse.put("data", response.getBody());
|
||||
@ -155,21 +259,32 @@ public class TunnelController implements ErrorController {
|
||||
return ResponseEntity.ok(jsonResponse);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete an ingress mapping from a tunnel.
|
||||
*
|
||||
* <p>Removes an ingress rule by hostname from the tunnel configuration.</p>
|
||||
*
|
||||
* @param tunnelId The Cloudflare tunnel ID (UUID)
|
||||
* @param ingress Ingress containing hostname to delete (only hostname field is used)
|
||||
* @return Map containing the result
|
||||
* @throws SecurityException if user lacks required role
|
||||
* @throws JsonProcessingException if JSON processing fails
|
||||
*/
|
||||
@PreAuthorize("hasAnyRole('DEVELOPER')")
|
||||
@DeleteMapping("/tunnels/{tunnelId}/mappings")
|
||||
public ResponseEntity<Map<String, Object>> deleteTunnelConfiguration(@PathVariable String tunnelId, @RequestBody Ingress ingress) throws JsonProcessingException {
|
||||
|
||||
ResponseEntity<TunnelResponse> responseEntity = cloudflareAPIService.getCloudflareTunnelConfigurations(tunnelId, restTemplateConfig.restTemplate(), TunnelResponse.class);
|
||||
|
||||
// * * Deleting the selected ingress value
|
||||
// Deleting the selected ingress value
|
||||
Config config = responseEntity.getBody().getResult().getConfig();
|
||||
List<Ingress> response_ingress = config.getIngress();
|
||||
Boolean result = Ingress.deleteByHostName(response_ingress, ingress.getHostname());
|
||||
|
||||
// * * Hitting put endpoint
|
||||
// Hitting put endpoint
|
||||
ResponseEntity<TunnelResponse> response = cloudflareAPIService.putCloudflareTunnelConfigurations(tunnelId, restTemplateConfig.restTemplate(), TunnelResponse.class, config);
|
||||
|
||||
// * * Displaying response
|
||||
// Displaying response
|
||||
Map<String, Object> jsonResponse = new HashMap<>();
|
||||
|
||||
if (result){
|
||||
@ -184,6 +299,20 @@ public class TunnelController implements ErrorController {
|
||||
return ResponseEntity.ok(jsonResponse);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a mapping change request.
|
||||
*
|
||||
* <p>Creates a new request for changing tunnel ingress mappings.
|
||||
* The request starts in PENDING status and must be approved
|
||||
* before the changes are applied.</p>
|
||||
*
|
||||
* @param tunnelId The Cloudflare tunnel ID (UUID)
|
||||
* @param oidcUser The authenticated user
|
||||
* @param ingess The ingress configuration to request
|
||||
* @return The created request with PENDING status
|
||||
* @throws SecurityException if user lacks required role
|
||||
* @see MappingRequestService#createMappingRequest(String, Ingress, OidcUser)
|
||||
*/
|
||||
@PreAuthorize("hasAnyRole('DEVELOPER')")
|
||||
@PostMapping("/tunnels/configure/{tunnelId}/requests")
|
||||
public ResponseEntity<Request> createTunnelMappingRequest(@PathVariable String tunnelId, @AuthenticationPrincipal OidcUser oidcUser, @RequestBody Ingress ingess){
|
||||
@ -193,6 +322,17 @@ public class TunnelController implements ErrorController {
|
||||
return ResponseEntity.status(HttpStatus.BAD_REQUEST).build();
|
||||
}
|
||||
|
||||
/**
|
||||
* Approve a mapping request.
|
||||
*
|
||||
* <p>Approves a pending mapping request. If approved, the
|
||||
* mapping will be applied to the Cloudflare tunnel.</p>
|
||||
*
|
||||
* @param requestId The ID of the request to approve
|
||||
* @param oidcUser The approver (must have APPROVER role)
|
||||
* @return The updated request with APPROVED status
|
||||
* @throws SecurityException if user lacks required role
|
||||
*/
|
||||
@PreAuthorize("hasAnyRole('APPROVER')")
|
||||
@PutMapping("/requests/{requestId}/approve")
|
||||
public ResponseEntity<Request> approveMappingRequest(@PathVariable UUID requestId, @AuthenticationPrincipal OidcUser oidcUser) {
|
||||
@ -210,6 +350,17 @@ public class TunnelController implements ErrorController {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Reject a mapping request.
|
||||
*
|
||||
* <p>Rejects a pending mapping request. No changes
|
||||
* will be made to the tunnel.</p>
|
||||
*
|
||||
* @param requestId The ID of the request to reject
|
||||
* @param oidcUser The rejecter (must have APPROVER role)
|
||||
* @return The updated request with REJECTED status
|
||||
* @throws SecurityException if user lacks required role
|
||||
*/
|
||||
@PreAuthorize("hasAnyRole('APPROVER')")
|
||||
@PutMapping("/requests/{requestId}/reject")
|
||||
public ResponseEntity<Request> rejectMappingRequest(@PathVariable UUID requestId, @AuthenticationPrincipal OidcUser oidcUser) {
|
||||
@ -227,13 +378,31 @@ public class TunnelController implements ErrorController {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Configure a tunnel for the current environment.
|
||||
*
|
||||
* <p>Creates a local configuration entry for a tunnel,
|
||||
* associating it with the current environment (from spring.profiles.active).</p>
|
||||
*
|
||||
* <p><b>Response Codes:</b></p>
|
||||
* <ul>
|
||||
* <li>200 - Created/updated with new tunnel</li>
|
||||
* <li>204 - No changes needed</li>
|
||||
* <li>404 - Tunnel not found in Cloudflare</li>
|
||||
* </ul>
|
||||
*
|
||||
* @param tunnelId The Cloudflare tunnel ID (UUID)
|
||||
* @param user The authenticated user
|
||||
* @return The tunnel configuration
|
||||
* @throws SecurityException if user lacks required role
|
||||
*/
|
||||
@PreAuthorize("hasAnyRole('ADMIN')")
|
||||
@PutMapping("/tunnels/configure/{tunnelId}")
|
||||
public ResponseEntity<Tunnel> configureTunnelForEnvironment(@PathVariable String tunnelId, @AuthenticationPrincipal OidcUser user) {
|
||||
/*
|
||||
* * Returns 200 if an object is created or updated with a new representation of the object
|
||||
* * Returns 204 if the object state did not need any changing.
|
||||
* * Returns 404 if the tunnelId is not valid
|
||||
* Returns 200 if an object is created or updated with a new representation of the object
|
||||
* Returns 204 if the object state did not need any changing.
|
||||
* Returns 404 if the tunnelId is not valid
|
||||
*/
|
||||
|
||||
try {
|
||||
@ -0,0 +1,86 @@
|
||||
package com.hithomelabs.cftunnels.Entity;
|
||||
|
||||
import jakarta.persistence.*;
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Getter;
|
||||
import lombok.NoArgsConstructor;
|
||||
import lombok.Setter;
|
||||
|
||||
import java.util.UUID;
|
||||
|
||||
/**
|
||||
* JPA Entity representing an ingress mapping configuration for a Cloudflare Tunnel.
|
||||
*
|
||||
* <p>A mapping defines how incoming traffic should be routed through the tunnel
|
||||
* to your internal services. It specifies the protocol, port, and subdomain
|
||||
* where the service will be accessible.</p>
|
||||
*
|
||||
* <p>Database Table: {@code mappings}</p>
|
||||
*
|
||||
* <p><b>Example Usage:</b></p>
|
||||
* <pre>
|
||||
* Mapping mapping = new Mapping();
|
||||
* mapping.setPort(8080);
|
||||
* mapping.setProtocol(Protocol.HTTP);
|
||||
* mapping.setSubdomain("api");
|
||||
* </pre>
|
||||
*
|
||||
* @see Tunnel
|
||||
* @see Protocol
|
||||
* @see Request
|
||||
*/
|
||||
@Entity
|
||||
@Getter
|
||||
@Setter
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
@Table(name = "mappings")
|
||||
public class Mapping {
|
||||
|
||||
/**
|
||||
* Unique identifier for this mapping (auto-generated UUID).
|
||||
*/
|
||||
@Id
|
||||
@GeneratedValue
|
||||
@Column(columnDefinition = "uuid", nullable = false, unique = true)
|
||||
private UUID id;
|
||||
|
||||
/**
|
||||
* Port number where the internal service is running.
|
||||
*
|
||||
* <p>Example: 8080 for a Spring Boot application's default port.</p>
|
||||
*/
|
||||
@Column(nullable = false)
|
||||
private int port;
|
||||
|
||||
/**
|
||||
* Protocol used for the connection.
|
||||
*
|
||||
* <p>Supported values: HTTP, HTTPS, TCP, SSH</p>
|
||||
* @see Protocol
|
||||
*/
|
||||
@Enumerated(EnumType.STRING)
|
||||
@Column(length = 10, nullable = false)
|
||||
private Protocol protocol;
|
||||
|
||||
/**
|
||||
* Subdomain prefix for accessing this service.
|
||||
*
|
||||
* <p>Example: "api" would make the service available at
|
||||
* {@code api.yourdomain.com}</p>
|
||||
*/
|
||||
@Column(length = 50, nullable = false)
|
||||
private String subdomain;
|
||||
|
||||
/**
|
||||
* The tunnel this mapping is associated with.
|
||||
*
|
||||
* <p>Each mapping belongs to exactly one tunnel.
|
||||
* This is a lazy-loaded relationship to optimize performance.</p>
|
||||
*
|
||||
* @see Tunnel
|
||||
*/
|
||||
@ManyToOne(fetch = FetchType.LAZY)
|
||||
@JoinColumn(name = "tunnel_id", nullable = false)
|
||||
private Tunnel tunnel;
|
||||
}
|
||||
@ -0,0 +1,43 @@
|
||||
package com.hithomelabs.cftunnels.Entity;
|
||||
|
||||
/**
|
||||
* Enum representing supported protocols for Cloudflare Tunnel ingress mappings.
|
||||
*
|
||||
* <p>Cloudflare Tunnel supports multiple protocols for routing traffic
|
||||
* to your internal services. This enum defines the available options.</p>
|
||||
*
|
||||
* <p><b>Supported Protocols:</b></p>
|
||||
* <ul>
|
||||
* <li>{@link #HTTP} - Standard HTTP protocol (port 80)</li>
|
||||
* <li>{@link #HTTPS} - Secure HTTP protocol (port 443)</li>
|
||||
* <li>{@link #TCP} - Raw TCP connections</li>
|
||||
* <li>{@link #SSH} - SSH protocol for remote access</li>
|
||||
* </ul>
|
||||
*
|
||||
* @see Mapping
|
||||
*/
|
||||
public enum Protocol {
|
||||
/**
|
||||
* HTTP protocol for web services.
|
||||
* Typically used with internal services running on port 80.
|
||||
*/
|
||||
HTTP,
|
||||
|
||||
/**
|
||||
* HTTPS protocol for secure web services.
|
||||
* Use this for services with TLS/SSL certificates.
|
||||
*/
|
||||
HTTPS,
|
||||
|
||||
/**
|
||||
* Raw TCP protocol for non-HTTP services.
|
||||
* Useful for databases, message queues, or custom protocols.
|
||||
*/
|
||||
TCP,
|
||||
|
||||
/**
|
||||
* SSH protocol for secure shell access.
|
||||
* Enables secure remote access to servers.
|
||||
*/
|
||||
SSH
|
||||
}
|
||||
@ -0,0 +1,120 @@
|
||||
package com.hithomelabs.cftunnels.Entity;
|
||||
|
||||
import jakarta.persistence.*;
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Getter;
|
||||
import lombok.NoArgsConstructor;
|
||||
import lombok.Setter;
|
||||
|
||||
import java.util.UUID;
|
||||
|
||||
/**
|
||||
* JPA Entity representing a mapping change request in the approval workflow.
|
||||
*
|
||||
* <p>This entity tracks requests to add or modify tunnel ingress mappings.
|
||||
* It implements an approval workflow where:</p>
|
||||
* <ul>
|
||||
* <li>Users create requests (status: PENDING)</li>
|
||||
* <li>Approvers review and approve/reject (status: APPROVED/REJECTED)</li>
|
||||
* </ul>
|
||||
*
|
||||
* <p><b>Database Table:</b> {@code requests}</p>
|
||||
*
|
||||
* <p><b>Workflow:</b></p>
|
||||
* <pre>
|
||||
* 1. User submits mapping request via REST API
|
||||
* 2. Request is created with PENDING status
|
||||
* 3. APPROVER role reviews the request
|
||||
* 4. If approved: mapping is applied to Cloudflare tunnel
|
||||
* 5. If rejected: request is marked REJECTED
|
||||
* </pre>
|
||||
*
|
||||
* @see Mapping
|
||||
* @see User
|
||||
* @see RequestStatus
|
||||
*/
|
||||
@Entity
|
||||
@Getter
|
||||
@Setter
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
@Table(name = "requests")
|
||||
public class Request {
|
||||
|
||||
/**
|
||||
* Unique identifier for this request (auto-generated UUID).
|
||||
*/
|
||||
@Id
|
||||
@GeneratedValue
|
||||
@Column(columnDefinition = "uuid", unique = true, nullable = false)
|
||||
private UUID id;
|
||||
|
||||
/**
|
||||
* The mapping configuration being requested.
|
||||
*
|
||||
* <p>This is a one-to-one relationship - each request
|
||||
* contains exactly one mapping configuration.</p>
|
||||
*
|
||||
* @see Mapping
|
||||
*/
|
||||
@OneToOne
|
||||
@JoinColumn(name = "mapping_id", unique = true, nullable = false)
|
||||
private Mapping mapping;
|
||||
|
||||
/**
|
||||
* User who created this request.
|
||||
*
|
||||
* <p>This field is required and tracks accountability.</p>
|
||||
*
|
||||
* @see User
|
||||
*/
|
||||
@ManyToOne
|
||||
@JoinColumn(name = "created_by", nullable = false)
|
||||
private User createdBy;
|
||||
|
||||
/**
|
||||
* User who approved or rejected this request.
|
||||
*
|
||||
* <p>This is null until the request is processed.</p>
|
||||
*
|
||||
* @see User
|
||||
*/
|
||||
@ManyToOne
|
||||
@JoinColumn(name = "accepted_by")
|
||||
private User acceptedBy;
|
||||
|
||||
/**
|
||||
* Status of the mapping request in the workflow.
|
||||
*
|
||||
* @see RequestStatus
|
||||
*/
|
||||
public enum RequestStatus {
|
||||
/**
|
||||
* Request is waiting for approval.
|
||||
*/
|
||||
PENDING,
|
||||
|
||||
/**
|
||||
* Request has been approved.
|
||||
* The mapping should now be applied to the tunnel.
|
||||
*/
|
||||
APPROVED,
|
||||
|
||||
/**
|
||||
* Request has been rejected.
|
||||
* No changes will be made to the tunnel.
|
||||
*/
|
||||
REJECTED
|
||||
}
|
||||
|
||||
/**
|
||||
* Current status of this request.
|
||||
*
|
||||
* <p>Initially set to PENDING when created.</p>
|
||||
*
|
||||
* @see RequestStatus
|
||||
*/
|
||||
@Enumerated(EnumType.STRING)
|
||||
@Column(length = 10, nullable = false)
|
||||
private RequestStatus status;
|
||||
}
|
||||
@ -0,0 +1,67 @@
|
||||
package com.hithomelabs.cftunnels.Entity;
|
||||
|
||||
import jakarta.persistence.*;
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Getter;
|
||||
import lombok.NoArgsConstructor;
|
||||
import lombok.Setter;
|
||||
|
||||
import java.util.UUID;
|
||||
|
||||
/**
|
||||
* JPA Entity representing a Cloudflare Tunnel configuration.
|
||||
*
|
||||
* <p>This entity stores the locally cached configuration of a Cloudflare Tunnel,
|
||||
* linking the tunnel's unique identifier from Cloudflare with its local
|
||||
* environment name for easier reference and management.</p>
|
||||
*
|
||||
* <p>The entity is uniquely constrained by tunnel ID and environment name,
|
||||
* ensuring only one configuration exists per tunnel per environment.</p>
|
||||
*
|
||||
* <p><b>Database Table:</b> {@code tunnels}</p>
|
||||
*
|
||||
* <p><b>Relationships:</b></p>
|
||||
* <ul>
|
||||
* <li>One Tunnel has many Mappings (via tunnel_id foreign key)</li>
|
||||
* </ul>
|
||||
*
|
||||
* @see Mapping
|
||||
* @see Request
|
||||
*/
|
||||
@Entity
|
||||
@Getter
|
||||
@Setter
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
@Table(name = "tunnels")
|
||||
public class Tunnel {
|
||||
|
||||
/**
|
||||
* Unique identifier for the tunnel (UUID).
|
||||
*
|
||||
* <p>This corresponds to the Cloudflare-assigned tunnel ID
|
||||
* and serves as the primary key for this entity.</p>
|
||||
*/
|
||||
@Id
|
||||
@Column(columnDefinition = "uuid", insertable = false, updatable = false, nullable = false)
|
||||
private UUID id;
|
||||
|
||||
/**
|
||||
* Environment name associated with this tunnel configuration.
|
||||
*
|
||||
* <p>Examples: "production", "staging", "development"</p>
|
||||
* <p>Each tunnel can be configured for multiple environments.</p>
|
||||
*/
|
||||
@Column(length = 10, unique = true, nullable = false)
|
||||
private String environment;
|
||||
|
||||
/**
|
||||
* Display name of the tunnel as configured in Cloudflare.
|
||||
*
|
||||
* <p>This is the user-friendly name assigned to the tunnel
|
||||
* when it was created in Cloudflare Zero Trust Dashboard
|
||||
* or via the Cloudflare API.</p>
|
||||
*/
|
||||
@Column(length = 50, unique = true, nullable = false)
|
||||
private String name;
|
||||
}
|
||||
@ -0,0 +1,68 @@
|
||||
package com.hithomelabs.cftunnels.Entity;
|
||||
|
||||
import jakarta.persistence.*;
|
||||
import jakarta.validation.constraints.Size;
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Getter;
|
||||
import lombok.NoArgsConstructor;
|
||||
import lombok.Setter;
|
||||
|
||||
import java.util.UUID;
|
||||
|
||||
/**
|
||||
* JPA Entity representing a user in the system.
|
||||
*
|
||||
* <p>This entity stores user information synced from the OIDC provider
|
||||
* during authentication. Users are assigned roles that determine their
|
||||
* access levels to the API endpoints.</p>
|
||||
*
|
||||
* <p><b>Database Table:</b> {@code users}</p>
|
||||
*
|
||||
* <p><b>Roles:</b></p>
|
||||
* <ul>
|
||||
* <li>USER - Basic access to view tunnels</li>
|
||||
* <li>DEVELOPER - Can create/modify mappings</li>
|
||||
* <li>APPROVER - Can approve/reject requests</li>
|
||||
* <li>ADMIN - Full access including tunnel configuration</li>
|
||||
* </ul>
|
||||
*
|
||||
* @see Request
|
||||
* @see Mapping
|
||||
*/
|
||||
@Entity
|
||||
@Getter
|
||||
@Setter
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
@Table(name = "users")
|
||||
public class User {
|
||||
|
||||
/**
|
||||
* Unique identifier for the user (UUID).
|
||||
*
|
||||
* <p>This corresponds to the user's ID in the OIDC provider.</p>
|
||||
*/
|
||||
@Id
|
||||
@GeneratedValue
|
||||
@Column(columnDefinition = "uuid", insertable = false, updatable = false, nullable = false)
|
||||
private UUID id;
|
||||
|
||||
/**
|
||||
* User's display name.
|
||||
*
|
||||
* <p>This is typically the full name from the OIDC provider.</p>
|
||||
*/
|
||||
@Column(length = 50, nullable = false)
|
||||
@Size(max = 50)
|
||||
private String name;
|
||||
|
||||
/**
|
||||
* User's email address.
|
||||
*
|
||||
* <p>Used as the unique identifier for authentication
|
||||
* and for associating users with their roles.</p>
|
||||
*/
|
||||
@Column(length = 50, nullable = false)
|
||||
@Size(max = 50)
|
||||
private String email;
|
||||
}
|
||||
@ -1,4 +1,4 @@
|
||||
package com.hithomelabs.CFTunnels.Exceptions;
|
||||
package com.hithomelabs.cftunnels.Exceptions;
|
||||
|
||||
public class ExternalServiceException extends RuntimeException {
|
||||
public ExternalServiceException(String message) { super(message); }
|
||||
@ -1,6 +1,6 @@
|
||||
package com.hithomelabs.CFTunnels.Headers;
|
||||
package com.hithomelabs.cftunnels.Headers;
|
||||
|
||||
import com.hithomelabs.CFTunnels.Config.CloudflareConfig;
|
||||
import com.hithomelabs.cftunnels.Config.CloudflareConfig;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.http.HttpHeaders;
|
||||
import org.springframework.stereotype.Component;
|
||||
@ -1,4 +1,4 @@
|
||||
package com.hithomelabs.CFTunnels.Models;
|
||||
package com.hithomelabs.cftunnels.Models;
|
||||
|
||||
public class Authorities {
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
package com.hithomelabs.CFTunnels.Models;
|
||||
package com.hithomelabs.cftunnels.Models;
|
||||
|
||||
import com.fasterxml.jackson.annotation.*;
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
package com.hithomelabs.CFTunnels.Models;
|
||||
package com.hithomelabs.cftunnels.Models;
|
||||
|
||||
public class Groups {
|
||||
|
||||
@ -0,0 +1,95 @@
|
||||
package com.hithomelabs.cftunnels.Models;
|
||||
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Getter;
|
||||
import lombok.NoArgsConstructor;
|
||||
import lombok.Setter;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* Model representing an ingress rule for a Cloudflare Tunnel.
|
||||
*
|
||||
* <p>Ingress rules define how incoming requests should be routed through
|
||||
* the tunnel to your internal services. Each rule specifies:</p>
|
||||
* <ul>
|
||||
* <li>{@link #hostname} - The domain/subdomain to match</li>
|
||||
* <li>{@link #service} - The internal service URL</li>
|
||||
* <li>{@link #originRequest} - Optional settings for origin requests</li>
|
||||
* <li>{@link #path} - Optional path prefix to match</li>
|
||||
* </ul>
|
||||
*
|
||||
* <p><b>Example JSON:</b></p>
|
||||
* <pre>
|
||||
* {
|
||||
* "hostname": "api.example.com",
|
||||
* "service": "http://localhost:8080",
|
||||
* "originRequest": {
|
||||
* "noTLSVerify": true
|
||||
* },
|
||||
* "path": "/api"
|
||||
* }
|
||||
* </pre>
|
||||
*
|
||||
* @see <a href="https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/routing/ingress/">Cloudflare Ingress Docs</a>
|
||||
*/
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
@Getter
|
||||
@Setter
|
||||
public class Ingress {
|
||||
|
||||
/**
|
||||
* The target service URL.
|
||||
*
|
||||
* <p>Format: {@code protocol://host:port}</p>
|
||||
* <p>Example: {@code http://localhost:8080}</p>
|
||||
*/
|
||||
private String service;
|
||||
|
||||
/**
|
||||
* Hostname pattern to match for this ingress rule.
|
||||
*
|
||||
* <p>Can be a full domain (api.example.com) or use wildcards
|
||||
* (*.example.com) to match subdomains.</p>
|
||||
* <p>If null, this rule acts as a catch-all.</p>
|
||||
*/
|
||||
private String hostname;
|
||||
|
||||
/**
|
||||
* Optional settings for requests to the origin server.
|
||||
*
|
||||
* <p>Supported options:</p>
|
||||
* <ul>
|
||||
* <li>noTLSVerify - Skip TLS verification</li>
|
||||
* <li>connectTimeout - Connection timeout in seconds</li>
|
||||
* <li>tlsTimeout - TLS handshake timeout</li>
|
||||
* <li>httpHostHeader - Host header to send</li>
|
||||
* </ul>
|
||||
*/
|
||||
private Map<String, Object> originRequest;
|
||||
|
||||
/**
|
||||
* Optional path to match before routing.
|
||||
*
|
||||
* <p>Example: "/api" would only route requests with
|
||||
* paths starting with /api to this service.</p>
|
||||
*/
|
||||
private String path;
|
||||
|
||||
/**
|
||||
* Removes an ingress rule by hostname from a list.
|
||||
*
|
||||
* <p>This utility method finds and removes the first ingress
|
||||
* matching the given hostname.</p>
|
||||
*
|
||||
* @param ingressList List of ingress rules to modify
|
||||
* @param toBeDeleted Hostname of the rule to remove
|
||||
* @return true if an ingress was removed, false otherwise
|
||||
*/
|
||||
public static boolean deleteByHostName(List<Ingress> ingressList, String toBeDeleted){
|
||||
return ingressList.removeIf(ingress -> ingress.getHostname() != null && ingress.getHostname().equals(toBeDeleted));
|
||||
}
|
||||
|
||||
}
|
||||
@ -1,4 +1,4 @@
|
||||
package com.hithomelabs.CFTunnels.Models;
|
||||
package com.hithomelabs.cftunnels.Models;
|
||||
|
||||
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
package com.hithomelabs.CFTunnels.Models;
|
||||
package com.hithomelabs.cftunnels.Models;
|
||||
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Getter;
|
||||
@ -1,4 +1,4 @@
|
||||
package com.hithomelabs.CFTunnels.Models;
|
||||
package com.hithomelabs.cftunnels.Models;
|
||||
|
||||
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
|
||||
import lombok.AllArgsConstructor;
|
||||
@ -1,4 +1,4 @@
|
||||
package com.hithomelabs.CFTunnels.Models;
|
||||
package com.hithomelabs.cftunnels.Models;
|
||||
|
||||
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
|
||||
import lombok.AllArgsConstructor;
|
||||
@ -1,6 +1,6 @@
|
||||
package com.hithomelabs.CFTunnels.Repositories;
|
||||
package com.hithomelabs.cftunnels.Repositories;
|
||||
|
||||
import com.hithomelabs.CFTunnels.Entity.Mapping;
|
||||
import com.hithomelabs.cftunnels.Entity.Mapping;
|
||||
import org.springframework.data.jpa.repository.JpaRepository;
|
||||
import org.springframework.stereotype.Repository;
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
package com.hithomelabs.CFTunnels.Repositories;
|
||||
package com.hithomelabs.cftunnels.Repositories;
|
||||
|
||||
import com.hithomelabs.CFTunnels.Entity.Request;
|
||||
import com.hithomelabs.cftunnels.Entity.Request;
|
||||
import org.springframework.data.domain.Page;
|
||||
import org.springframework.data.domain.Pageable;
|
||||
import org.springframework.data.jpa.repository.JpaRepository;
|
||||
@ -1,6 +1,6 @@
|
||||
package com.hithomelabs.CFTunnels.Repositories;
|
||||
package com.hithomelabs.cftunnels.Repositories;
|
||||
|
||||
import com.hithomelabs.CFTunnels.Entity.Tunnel;
|
||||
import com.hithomelabs.cftunnels.Entity.Tunnel;
|
||||
import org.springframework.data.jpa.repository.JpaRepository;
|
||||
import org.springframework.stereotype.Repository;
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
package com.hithomelabs.CFTunnels.Repositories;
|
||||
package com.hithomelabs.cftunnels.Repositories;
|
||||
|
||||
import com.hithomelabs.CFTunnels.Entity.User;
|
||||
import com.hithomelabs.cftunnels.Entity.User;
|
||||
import org.springframework.data.jpa.repository.JpaRepository;
|
||||
import org.springframework.stereotype.Repository;
|
||||
|
||||
@ -0,0 +1,203 @@
|
||||
package com.hithomelabs.cftunnels.Services;
|
||||
|
||||
import com.hithomelabs.cftunnels.Config.CloudflareConfig;
|
||||
import com.hithomelabs.cftunnels.Entity.Tunnel;
|
||||
import com.hithomelabs.cftunnels.Exceptions.ExternalServiceException;
|
||||
import com.hithomelabs.cftunnels.Headers.AuthKeyEmailHeader;
|
||||
import com.hithomelabs.cftunnels.Models.Config;
|
||||
import com.hithomelabs.cftunnels.Models.Ingress;
|
||||
import com.hithomelabs.cftunnels.Models.TunnelResponse;
|
||||
import com.hithomelabs.cftunnels.Models.TunnelResult;
|
||||
import com.hithomelabs.cftunnels.Models.TunnelsResponse;
|
||||
import com.hithomelabs.cftunnels.Repositories.TunnelRepository;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.dao.DataAccessException;
|
||||
import org.springframework.http.*;
|
||||
import org.springframework.stereotype.Service;
|
||||
import org.springframework.web.client.RestTemplate;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.NoSuchElementException;
|
||||
import java.util.Optional;
|
||||
import java.util.UUID;
|
||||
|
||||
/**
|
||||
* Service for interacting with the Cloudflare Tunnel API.
|
||||
*
|
||||
* <p>This service provides methods to manage Cloudflare Tunnels,
|
||||
* including fetching tunnel configurations, creating/updating tunnels,
|
||||
* and adding ingress mappings. It handles all communication with the
|
||||
* Cloudflare API using the configured credentials.</p>
|
||||
*
|
||||
* <p><b>API Endpoints Used:</b></p>
|
||||
* <ul>
|
||||
* <li>GET /accounts/{accountId}/cfd_tunnel - List all tunnels</li>
|
||||
* <li>GET /accounts/{accountId}/cfd_tunnel/{tunnelId}/configurations - Get tunnel config</li>
|
||||
* <li>PUT /accounts/{accountId}/cfd_tunnel/{tunnelId}/configurations - Update tunnel config</li>
|
||||
* </ul>
|
||||
*
|
||||
* @see CloudflareConfig
|
||||
* @see Tunnel
|
||||
* @see Ingress
|
||||
*/
|
||||
@Service
|
||||
public class CloudflareAPIService {
|
||||
|
||||
/**
|
||||
* Configuration for Cloudflare API credentials and settings.
|
||||
* Loaded from application.properties using the {@code cloudflare.*} prefix.
|
||||
*/
|
||||
@Autowired
|
||||
CloudflareConfig cloudflareConfig;
|
||||
|
||||
/**
|
||||
* Header provider for Cloudflare API authentication.
|
||||
* Generates the X-Auth-Key and X-Auth-Email headers.
|
||||
*/
|
||||
@Autowired
|
||||
AuthKeyEmailHeader authKeyEmailHeader;
|
||||
|
||||
/**
|
||||
* HTTP client for making API requests.
|
||||
*/
|
||||
@Autowired
|
||||
RestTemplate restTemplate;
|
||||
|
||||
/**
|
||||
* Repository for storing tunnel configurations locally.
|
||||
*/
|
||||
@Autowired
|
||||
TunnelRepository tunnelRepository;
|
||||
|
||||
/**
|
||||
* Fetches all Cloudflare tunnels from the API.
|
||||
*
|
||||
* @return Response containing the list of tunnels from Cloudflare
|
||||
* @see TunnelsResponse
|
||||
*/
|
||||
public ResponseEntity<TunnelsResponse> getCloudflareTunnels() {
|
||||
|
||||
String url = "https://api.cloudflare.com/client/v4/accounts/" + cloudflareConfig.getAccountId() + "/cfd_tunnel";
|
||||
|
||||
HttpEntity<String> httpEntity = new HttpEntity<>("", authKeyEmailHeader.getHttpHeaders());
|
||||
ResponseEntity<TunnelsResponse> responseEntity = restTemplate.exchange(url, HttpMethod.GET, httpEntity, TunnelsResponse.class);
|
||||
return responseEntity;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches the configuration for a specific tunnel.
|
||||
*
|
||||
* @param tunnelId The Cloudflare tunnel ID (UUID string)
|
||||
* @param restTemplate HTTP client to use for the request
|
||||
* @param responseType Class to deserialize the response into
|
||||
* @param <T> Response type
|
||||
* @return Response containing the tunnel configuration
|
||||
*/
|
||||
public <T> ResponseEntity<T> getCloudflareTunnelConfigurations(String tunnelId, RestTemplate restTemplate, Class<T> responseType) {
|
||||
|
||||
// Resource URL to hit get request at
|
||||
String url = "https://api.cloudflare.com/client/v4/accounts/" + cloudflareConfig.getAccountId() + "/cfd_tunnel/" + tunnelId + "/configurations";
|
||||
|
||||
HttpEntity<String> httpEntity = new HttpEntity<>("",authKeyEmailHeader.getHttpHeaders());
|
||||
ResponseEntity<T> responseEntity = restTemplate.exchange(url, HttpMethod.GET, httpEntity, responseType);
|
||||
return responseEntity;
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the configuration for a specific tunnel.
|
||||
*
|
||||
* <p>This method is used to add, modify, or remove ingress mappings
|
||||
* by providing a complete configuration object.</p>
|
||||
*
|
||||
* @param tunnelId The Cloudflare tunnel ID (UUID string)
|
||||
* @param restTemplate HTTP client to use for the request
|
||||
* @param responseType Class to deserialize the response into
|
||||
* @param config The new configuration to apply
|
||||
* @param <T> Response type
|
||||
* @return Response containing the updated tunnel configuration
|
||||
*/
|
||||
public <T> ResponseEntity<T> putCloudflareTunnelConfigurations(String tunnelId, RestTemplate restTemplate, Class<T> responseType, Config config) {
|
||||
|
||||
// Resource URL to hit get request at
|
||||
String url = "https://api.cloudflare.com/client/v4/accounts/" + cloudflareConfig.getAccountId() + "/cfd_tunnel/" + tunnelId + "/configurations";
|
||||
|
||||
HttpHeaders httpHeaders = authKeyEmailHeader.getHttpHeaders();
|
||||
httpHeaders.setContentType(MediaType.APPLICATION_JSON);
|
||||
HttpEntity<Config> entity = new HttpEntity<>(config, httpHeaders);
|
||||
ResponseEntity<T> responseEntity = restTemplate.exchange(url, HttpMethod.PUT, entity, responseType);
|
||||
return responseEntity;
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts a Cloudflare API tunnel result to a local Tunnel entity.
|
||||
*
|
||||
* @param tunnelResult The tunnel result from Cloudflare API
|
||||
* @param env The environment name to associate
|
||||
* @return New Tunnel entity instance
|
||||
*/
|
||||
private Tunnel getTunnelFromTunnelResponse(TunnelResult tunnelResult, String env){
|
||||
return new Tunnel(UUID.fromString(tunnelResult.getId()), env, tunnelResult.getName());
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates or updates a tunnel's local configuration.
|
||||
*
|
||||
* <p>This method fetches the tunnel from Cloudflare API, validates it exists,
|
||||
* and stores a local copy with the environment association.</p>
|
||||
*
|
||||
* @param tunnelId The Cloudflare tunnel ID
|
||||
* @param environment Environment name (e.g., "production", "staging")
|
||||
* @return The created or updated Tunnel entity
|
||||
* @throws ExternalServiceException if Cloudflare API returns an error
|
||||
* @throws NoSuchElementException if the tunnel doesn't exist in Cloudflare
|
||||
*/
|
||||
public Tunnel createOrUpdateTunnel(String tunnelId, String environment) throws ExternalServiceException, NoSuchElementException {
|
||||
|
||||
ResponseEntity<TunnelsResponse> responseEntity = getCloudflareTunnels();
|
||||
|
||||
if (responseEntity.getStatusCode().isError())
|
||||
throw new ExternalServiceException("Cloudflare API error: " + responseEntity.getStatusCode());
|
||||
|
||||
TunnelResult tunnelResult = responseEntity.getBody().getResult().stream().filter(t -> t.getId().equals(tunnelId)).findFirst().orElse(null);
|
||||
if (tunnelResult == null)
|
||||
throw new NoSuchElementException();
|
||||
|
||||
Tunnel toBeConfigured = getTunnelFromTunnelResponse(tunnelResult, environment);
|
||||
Tunnel fromDatabase = tunnelRepository.findById(UUID.fromString(tunnelId)).orElse(null);
|
||||
|
||||
if (fromDatabase != null)
|
||||
tunnelRepository.deleteById(UUID.fromString(tunnelId));
|
||||
tunnelRepository.save(toBeConfigured);
|
||||
return toBeConfigured;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves all tunnels that have been locally configured.
|
||||
*
|
||||
* @return List of locally configured tunnels
|
||||
*/
|
||||
public List<Tunnel> getAllConfiguredTunnels() {
|
||||
return tunnelRepository.findAll();
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds an ingress mapping to an existing tunnel.
|
||||
*
|
||||
* <p>The new ingress is inserted at the second-to-last position in the
|
||||
* ingress list (Cloudflare requires a catch-all rule at the end).</p>
|
||||
*
|
||||
* @param tunnelId The Cloudflare tunnel ID
|
||||
* @param ingress The ingress configuration to add
|
||||
* @return Response with the updated tunnel configuration
|
||||
*/
|
||||
public ResponseEntity<TunnelResponse> addTunnelIngress(String tunnelId, Ingress ingress) {
|
||||
ResponseEntity<TunnelResponse> currentConfig = getCloudflareTunnelConfigurations(tunnelId, restTemplate, TunnelResponse.class);
|
||||
|
||||
Config config = currentConfig.getBody().getResult().getConfig();
|
||||
List<Ingress> ingressList = config.getIngress();
|
||||
ingressList.add(ingressList.size() - 1, ingress);
|
||||
|
||||
return putCloudflareTunnelConfigurations(tunnelId, restTemplate, TunnelResponse.class, config);
|
||||
}
|
||||
}
|
||||
@ -1,15 +1,15 @@
|
||||
package com.hithomelabs.CFTunnels.Services;
|
||||
package com.hithomelabs.cftunnels.Services;
|
||||
|
||||
import com.hithomelabs.CFTunnels.Entity.Mapping;
|
||||
import com.hithomelabs.CFTunnels.Entity.Protocol;
|
||||
import com.hithomelabs.CFTunnels.Entity.Request;
|
||||
import com.hithomelabs.CFTunnels.Entity.Tunnel;
|
||||
import com.hithomelabs.CFTunnels.Entity.User;
|
||||
import com.hithomelabs.CFTunnels.Models.Ingress;
|
||||
import com.hithomelabs.CFTunnels.Repositories.MappingRepository;
|
||||
import com.hithomelabs.CFTunnels.Repositories.RequestRepository;
|
||||
import com.hithomelabs.CFTunnels.Repositories.TunnelRepository;
|
||||
import com.hithomelabs.CFTunnels.Repositories.UserRepository;
|
||||
import com.hithomelabs.cftunnels.Entity.Mapping;
|
||||
import com.hithomelabs.cftunnels.Entity.Protocol;
|
||||
import com.hithomelabs.cftunnels.Entity.Request;
|
||||
import com.hithomelabs.cftunnels.Entity.Tunnel;
|
||||
import com.hithomelabs.cftunnels.Entity.User;
|
||||
import com.hithomelabs.cftunnels.Models.Ingress;
|
||||
import com.hithomelabs.cftunnels.Repositories.MappingRepository;
|
||||
import com.hithomelabs.cftunnels.Repositories.RequestRepository;
|
||||
import com.hithomelabs.cftunnels.Repositories.TunnelRepository;
|
||||
import com.hithomelabs.cftunnels.Repositories.UserRepository;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
import org.springframework.security.oauth2.core.oidc.user.OidcUser;
|
||||
@ -5,3 +5,7 @@ spring.datasource.driver-class-name=org.h2.Driver
|
||||
spring.datasource.username=sa
|
||||
spring.datasource.password=
|
||||
spring.jpa.hibernate.ddl-auto=none
|
||||
|
||||
# Actuator configuration for CI
|
||||
management.endpoints.web.exposure.include=health,info
|
||||
management.endpoint.health.show-details=never
|
||||
@ -1,8 +1,10 @@
|
||||
api.baseUrl=http://localhost:8080
|
||||
|
||||
management.health.db.enabled=true
|
||||
management.endpoints.web.exposure.include=health
|
||||
# Actuator configuration for local development
|
||||
management.server.port=8081
|
||||
management.endpoints.web.exposure.include=health,info
|
||||
management.endpoint.health.show-details=always
|
||||
management.health.db.enabled=true
|
||||
|
||||
logging.level.org.hibernate.SQL=DEBUG
|
||||
debug=true
|
||||
@ -10,3 +10,7 @@ spring.datasource.driver-class-name=org.postgresql.Driver
|
||||
spring.jpa.hibernate.ddl-auto=create-drop
|
||||
spring.jpa.show-sql=false
|
||||
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
|
||||
|
||||
# Actuator configuration
|
||||
management.endpoints.web.exposure.include=health,info
|
||||
management.endpoint.health.show-details=when-authorized
|
||||
@ -10,3 +10,7 @@ spring.datasource.driver-class-name=org.postgresql.Driver
|
||||
spring.jpa.hibernate.ddl-auto=update
|
||||
spring.jpa.show-sql=true
|
||||
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
|
||||
|
||||
# Actuator configuration
|
||||
management.endpoints.web.exposure.include=health,info
|
||||
management.endpoint.health.show-details=when-authorized
|
||||
@ -2,9 +2,9 @@ spring.application.name=CFTunnels
|
||||
cloudflare.accountId=${CLOUDFLARE_ACCOUNT_ID}
|
||||
cloudflare.apiKey=${CLOUDFLARE_API_KEY}
|
||||
cloudflare.email=${CLOUDFLARE_EMAIL}
|
||||
spring.profiles.active=${ENV}
|
||||
spring.profiles.active=${ENV:default}
|
||||
|
||||
/ * * Masking sure app works behind a reverse proxy
|
||||
# Making sure app works behind a reverse proxy
|
||||
server.forward-headers-strategy=framework
|
||||
|
||||
spring.security.oauth2.client.registration.cftunnels.client-id=${OAUTH_CLIENT_ID}
|
||||
@ -36,3 +36,8 @@ spring.jpa.show-sql=true
|
||||
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
|
||||
|
||||
spring.jpa.open-in-view=false
|
||||
|
||||
# Actuator configuration - management port and exposed endpoints
|
||||
management.server.port=8081
|
||||
management.endpoints.web.exposure.include=health,info
|
||||
management.endpoint.health.show-details=when-authorized
|
||||
@ -1,4 +1,4 @@
|
||||
package com.hithomelabs.CFTunnels;
|
||||
package com.hithomelabs.cftunnels;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.springframework.boot.test.context.SpringBootTest;
|
||||
@ -1,21 +1,21 @@
|
||||
package com.hithomelabs.CFTunnels.Controllers;
|
||||
package com.hithomelabs.cftunnels.Controllers;
|
||||
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import com.hithomelabs.CFTunnels.Config.AuthoritiesToGroupMapping;
|
||||
import com.hithomelabs.CFTunnels.Config.CloudflareConfig;
|
||||
import com.hithomelabs.CFTunnels.Config.RestTemplateConfig;
|
||||
import com.hithomelabs.CFTunnels.Headers.AuthKeyEmailHeader;
|
||||
import com.hithomelabs.CFTunnels.Entity.Request;
|
||||
import com.hithomelabs.CFTunnels.Entity.Tunnel;
|
||||
import com.hithomelabs.CFTunnels.Models.Authorities;
|
||||
import com.hithomelabs.CFTunnels.Models.Config;
|
||||
import com.hithomelabs.CFTunnels.Models.Groups;
|
||||
import com.hithomelabs.CFTunnels.Models.TunnelResponse;
|
||||
import com.hithomelabs.CFTunnels.Models.TunnelResult;
|
||||
import com.hithomelabs.CFTunnels.Models.TunnelsResponse;
|
||||
import com.hithomelabs.CFTunnels.Repositories.UserRepository;
|
||||
import com.hithomelabs.CFTunnels.Services.CloudflareAPIService;
|
||||
import com.hithomelabs.CFTunnels.Services.MappingRequestService;
|
||||
import com.hithomelabs.cftunnels.Config.AuthoritiesToGroupMapping;
|
||||
import com.hithomelabs.cftunnels.Config.CloudflareConfig;
|
||||
import com.hithomelabs.common.config.RestTemplateConfig;
|
||||
import com.hithomelabs.cftunnels.Headers.AuthKeyEmailHeader;
|
||||
import com.hithomelabs.cftunnels.Entity.Request;
|
||||
import com.hithomelabs.cftunnels.Entity.Tunnel;
|
||||
import com.hithomelabs.cftunnels.Models.Authorities;
|
||||
import com.hithomelabs.cftunnels.Models.Config;
|
||||
import com.hithomelabs.cftunnels.Models.Groups;
|
||||
import com.hithomelabs.cftunnels.Models.TunnelResponse;
|
||||
import com.hithomelabs.cftunnels.Models.TunnelResult;
|
||||
import com.hithomelabs.cftunnels.Models.TunnelsResponse;
|
||||
import com.hithomelabs.cftunnels.Repositories.UserRepository;
|
||||
import com.hithomelabs.cftunnels.Services.CloudflareAPIService;
|
||||
import com.hithomelabs.cftunnels.Services.MappingRequestService;
|
||||
import org.junit.jupiter.api.DisplayName;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
@ -38,7 +38,7 @@ import org.springframework.data.domain.Page;
|
||||
import org.springframework.data.domain.PageImpl;
|
||||
import org.springframework.data.domain.PageRequest;
|
||||
|
||||
import static com.hithomelabs.CFTunnels.TestUtils.Util.getClassPathDataResource;
|
||||
import static com.hithomelabs.cftunnels.TestUtils.Util.getClassPathDataResource;
|
||||
import static org.hamcrest.core.IsIterableContaining.hasItem;
|
||||
import static org.mockito.ArgumentMatchers.any;
|
||||
import static org.mockito.ArgumentMatchers.eq;
|
||||
@ -207,9 +207,9 @@ class TunnelControllerTest {
|
||||
@Test
|
||||
@DisplayName("should return list of requests")
|
||||
void getAllRequests_Success() throws Exception {
|
||||
List<com.hithomelabs.CFTunnels.Entity.Request> requests = Arrays.asList(
|
||||
createTestRequest(UUID.randomUUID(), com.hithomelabs.CFTunnels.Entity.Request.RequestStatus.PENDING),
|
||||
createTestRequest(UUID.randomUUID(), com.hithomelabs.CFTunnels.Entity.Request.RequestStatus.APPROVED)
|
||||
List<com.hithomelabs.cftunnels.Entity.Request> requests = Arrays.asList(
|
||||
createTestRequest(UUID.randomUUID(), com.hithomelabs.cftunnels.Entity.Request.RequestStatus.PENDING),
|
||||
createTestRequest(UUID.randomUUID(), com.hithomelabs.cftunnels.Entity.Request.RequestStatus.APPROVED)
|
||||
);
|
||||
|
||||
when(mappingRequestService.getAllRequests()).thenReturn(requests);
|
||||
@ -227,11 +227,11 @@ class TunnelControllerTest {
|
||||
@DisplayName("should create mapping request successfully")
|
||||
void createTunnelMappingRequest_Success() throws Exception {
|
||||
UUID tunnelId = UUID.randomUUID();
|
||||
com.hithomelabs.CFTunnels.Entity.Request createdRequest = new com.hithomelabs.CFTunnels.Entity.Request();
|
||||
com.hithomelabs.cftunnels.Entity.Request createdRequest = new com.hithomelabs.cftunnels.Entity.Request();
|
||||
createdRequest.setId(UUID.randomUUID());
|
||||
createdRequest.setStatus(com.hithomelabs.CFTunnels.Entity.Request.RequestStatus.PENDING);
|
||||
createdRequest.setStatus(com.hithomelabs.cftunnels.Entity.Request.RequestStatus.PENDING);
|
||||
|
||||
when(mappingRequestService.createMappingRequest(any(String.class), any(com.hithomelabs.CFTunnels.Models.Ingress.class), any())).thenReturn(createdRequest);
|
||||
when(mappingRequestService.createMappingRequest(any(String.class), any(com.hithomelabs.cftunnels.Models.Ingress.class), any())).thenReturn(createdRequest);
|
||||
|
||||
mockMvc.perform(post("/cloudflare/tunnels/configure/{tunnelId}/requests", tunnelId.toString())
|
||||
.with(oauth2Login().oauth2User(buildOidcUser("developer", Groups.HOMELAB_DEVELOPER)))
|
||||
@ -247,15 +247,15 @@ class TunnelControllerTest {
|
||||
@DisplayName("should approve mapping request successfully")
|
||||
void approveMappingRequest_Success() throws Exception {
|
||||
UUID requestId = UUID.randomUUID();
|
||||
com.hithomelabs.CFTunnels.Entity.User approverUser = new com.hithomelabs.CFTunnels.Entity.User();
|
||||
com.hithomelabs.cftunnels.Entity.User approverUser = new com.hithomelabs.cftunnels.Entity.User();
|
||||
approverUser.setEmail("approver@example.com");
|
||||
approverUser.setName("Approver");
|
||||
|
||||
com.hithomelabs.CFTunnels.Entity.Request approvedRequest = new com.hithomelabs.CFTunnels.Entity.Request();
|
||||
com.hithomelabs.cftunnels.Entity.Request approvedRequest = new com.hithomelabs.cftunnels.Entity.Request();
|
||||
approvedRequest.setId(requestId);
|
||||
approvedRequest.setStatus(com.hithomelabs.CFTunnels.Entity.Request.RequestStatus.APPROVED);
|
||||
approvedRequest.setStatus(com.hithomelabs.cftunnels.Entity.Request.RequestStatus.APPROVED);
|
||||
|
||||
when(mappingRequestService.approveRequest(eq(requestId), any(com.hithomelabs.CFTunnels.Entity.User.class)))
|
||||
when(mappingRequestService.approveRequest(eq(requestId), any(com.hithomelabs.cftunnels.Entity.User.class)))
|
||||
.thenReturn(approvedRequest);
|
||||
when(userRepository.findByEmail("approver@example.com"))
|
||||
.thenReturn(java.util.Optional.of(approverUser));
|
||||
@ -272,11 +272,11 @@ class TunnelControllerTest {
|
||||
@DisplayName("should return 404 when request not found")
|
||||
void approveMappingRequest_NotFound() throws Exception {
|
||||
UUID requestId = UUID.randomUUID();
|
||||
com.hithomelabs.CFTunnels.Entity.User approverUser = new com.hithomelabs.CFTunnels.Entity.User();
|
||||
com.hithomelabs.cftunnels.Entity.User approverUser = new com.hithomelabs.cftunnels.Entity.User();
|
||||
approverUser.setEmail("approver@example.com");
|
||||
approverUser.setName("Approver");
|
||||
|
||||
when(mappingRequestService.approveRequest(eq(requestId), any(com.hithomelabs.CFTunnels.Entity.User.class)))
|
||||
when(mappingRequestService.approveRequest(eq(requestId), any(com.hithomelabs.cftunnels.Entity.User.class)))
|
||||
.thenThrow(new NoSuchElementException("Request not found"));
|
||||
when(userRepository.findByEmail("approver@example.com"))
|
||||
.thenReturn(java.util.Optional.of(approverUser));
|
||||
@ -291,11 +291,11 @@ class TunnelControllerTest {
|
||||
@DisplayName("should return 500 when mapping creation fails")
|
||||
void approveMappingRequest_InternalServerError() throws Exception {
|
||||
UUID requestId = UUID.randomUUID();
|
||||
com.hithomelabs.CFTunnels.Entity.User approverUser = new com.hithomelabs.CFTunnels.Entity.User();
|
||||
com.hithomelabs.cftunnels.Entity.User approverUser = new com.hithomelabs.cftunnels.Entity.User();
|
||||
approverUser.setEmail("approver@example.com");
|
||||
approverUser.setName("Approver");
|
||||
|
||||
when(mappingRequestService.approveRequest(eq(requestId), any(com.hithomelabs.CFTunnels.Entity.User.class)))
|
||||
when(mappingRequestService.approveRequest(eq(requestId), any(com.hithomelabs.cftunnels.Entity.User.class)))
|
||||
.thenThrow(new RuntimeException("Failed to add mapping to Cloudflare"));
|
||||
when(userRepository.findByEmail("approver@example.com"))
|
||||
.thenReturn(java.util.Optional.of(approverUser));
|
||||
@ -310,15 +310,15 @@ class TunnelControllerTest {
|
||||
@DisplayName("should reject mapping request successfully")
|
||||
void rejectMappingRequest_Success() throws Exception {
|
||||
UUID requestId = UUID.randomUUID();
|
||||
com.hithomelabs.CFTunnels.Entity.User rejecterUser = new com.hithomelabs.CFTunnels.Entity.User();
|
||||
com.hithomelabs.cftunnels.Entity.User rejecterUser = new com.hithomelabs.cftunnels.Entity.User();
|
||||
rejecterUser.setEmail("rejecter@example.com");
|
||||
rejecterUser.setName("Rejecter");
|
||||
|
||||
com.hithomelabs.CFTunnels.Entity.Request rejectedRequest = new com.hithomelabs.CFTunnels.Entity.Request();
|
||||
com.hithomelabs.cftunnels.Entity.Request rejectedRequest = new com.hithomelabs.cftunnels.Entity.Request();
|
||||
rejectedRequest.setId(requestId);
|
||||
rejectedRequest.setStatus(com.hithomelabs.CFTunnels.Entity.Request.RequestStatus.REJECTED);
|
||||
rejectedRequest.setStatus(com.hithomelabs.cftunnels.Entity.Request.RequestStatus.REJECTED);
|
||||
|
||||
when(mappingRequestService.rejectRequest(eq(requestId), any(com.hithomelabs.CFTunnels.Entity.User.class)))
|
||||
when(mappingRequestService.rejectRequest(eq(requestId), any(com.hithomelabs.cftunnels.Entity.User.class)))
|
||||
.thenReturn(rejectedRequest);
|
||||
when(userRepository.findByEmail("rejecter@example.com"))
|
||||
.thenReturn(java.util.Optional.of(rejecterUser));
|
||||
@ -335,11 +335,11 @@ class TunnelControllerTest {
|
||||
@DisplayName("should return 404 when rejecting non-existent request")
|
||||
void rejectMappingRequest_NotFound() throws Exception {
|
||||
UUID requestId = UUID.randomUUID();
|
||||
com.hithomelabs.CFTunnels.Entity.User rejecterUser = new com.hithomelabs.CFTunnels.Entity.User();
|
||||
com.hithomelabs.cftunnels.Entity.User rejecterUser = new com.hithomelabs.cftunnels.Entity.User();
|
||||
rejecterUser.setEmail("rejecter@example.com");
|
||||
rejecterUser.setName("Rejecter");
|
||||
|
||||
when(mappingRequestService.rejectRequest(eq(requestId), any(com.hithomelabs.CFTunnels.Entity.User.class)))
|
||||
when(mappingRequestService.rejectRequest(eq(requestId), any(com.hithomelabs.cftunnels.Entity.User.class)))
|
||||
.thenThrow(new NoSuchElementException("Request not found"));
|
||||
when(userRepository.findByEmail("rejecter@example.com"))
|
||||
.thenReturn(java.util.Optional.of(rejecterUser));
|
||||
@ -354,11 +354,11 @@ class TunnelControllerTest {
|
||||
@DisplayName("should return 409 when rejecting already processed request")
|
||||
void rejectMappingRequest_Conflict() throws Exception {
|
||||
UUID requestId = UUID.randomUUID();
|
||||
com.hithomelabs.CFTunnels.Entity.User rejecterUser = new com.hithomelabs.CFTunnels.Entity.User();
|
||||
com.hithomelabs.cftunnels.Entity.User rejecterUser = new com.hithomelabs.cftunnels.Entity.User();
|
||||
rejecterUser.setEmail("rejecter@example.com");
|
||||
rejecterUser.setName("Rejecter");
|
||||
|
||||
when(mappingRequestService.rejectRequest(eq(requestId), any(com.hithomelabs.CFTunnels.Entity.User.class)))
|
||||
when(mappingRequestService.rejectRequest(eq(requestId), any(com.hithomelabs.cftunnels.Entity.User.class)))
|
||||
.thenThrow(new IllegalStateException("Request is not in PENDING status"));
|
||||
when(userRepository.findByEmail("rejecter@example.com"))
|
||||
.thenReturn(java.util.Optional.of(rejecterUser));
|
||||
@ -1,13 +1,13 @@
|
||||
package com.hithomelabs.CFTunnels.Integration;
|
||||
package com.hithomelabs.cftunnels.Integration;
|
||||
|
||||
import com.hithomelabs.CFTunnels.Config.CloudflareConfig;
|
||||
import com.hithomelabs.CFTunnels.Headers.AuthKeyEmailHeader;
|
||||
import com.hithomelabs.CFTunnels.Models.Config;
|
||||
import com.hithomelabs.CFTunnels.Models.Ingress;
|
||||
import com.hithomelabs.CFTunnels.Models.TunnelResponse;
|
||||
import com.hithomelabs.CFTunnels.Models.TunnelResult;
|
||||
import com.hithomelabs.CFTunnels.Models.TunnelsResponse;
|
||||
import com.hithomelabs.CFTunnels.Services.CloudflareAPIService;
|
||||
import com.hithomelabs.cftunnels.Config.CloudflareConfig;
|
||||
import com.hithomelabs.cftunnels.Headers.AuthKeyEmailHeader;
|
||||
import com.hithomelabs.cftunnels.Models.Config;
|
||||
import com.hithomelabs.cftunnels.Models.Ingress;
|
||||
import com.hithomelabs.cftunnels.Models.TunnelResponse;
|
||||
import com.hithomelabs.cftunnels.Models.TunnelResult;
|
||||
import com.hithomelabs.cftunnels.Models.TunnelsResponse;
|
||||
import com.hithomelabs.cftunnels.Services.CloudflareAPIService;
|
||||
import org.junit.jupiter.api.DisplayName;
|
||||
import org.junit.jupiter.api.Tag;
|
||||
import org.junit.jupiter.api.Test;
|
||||
@ -1,10 +1,10 @@
|
||||
package com.hithomelabs.CFTunnels.Repositories;
|
||||
package com.hithomelabs.cftunnels.Repositories;
|
||||
|
||||
import com.hithomelabs.CFTunnels.Entity.Mapping;
|
||||
import com.hithomelabs.CFTunnels.Entity.Protocol;
|
||||
import com.hithomelabs.CFTunnels.Entity.Request;
|
||||
import com.hithomelabs.CFTunnels.Entity.Tunnel;
|
||||
import com.hithomelabs.CFTunnels.Entity.User;
|
||||
import com.hithomelabs.cftunnels.Entity.Mapping;
|
||||
import com.hithomelabs.cftunnels.Entity.Protocol;
|
||||
import com.hithomelabs.cftunnels.Entity.Request;
|
||||
import com.hithomelabs.cftunnels.Entity.Tunnel;
|
||||
import com.hithomelabs.cftunnels.Entity.User;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.DisplayName;
|
||||
import org.junit.jupiter.api.Test;
|
||||
@ -1,17 +1,17 @@
|
||||
package com.hithomelabs.CFTunnels.Services;
|
||||
package com.hithomelabs.cftunnels.Services;
|
||||
|
||||
import com.fasterxml.jackson.core.JsonProcessingException;
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import com.hithomelabs.CFTunnels.Config.CloudflareConfig;
|
||||
import com.hithomelabs.CFTunnels.Entity.Tunnel;
|
||||
import com.hithomelabs.CFTunnels.Exceptions.ExternalServiceException;
|
||||
import com.hithomelabs.CFTunnels.Headers.AuthKeyEmailHeader;
|
||||
import com.hithomelabs.CFTunnels.Models.Config;
|
||||
import com.hithomelabs.CFTunnels.Models.Ingress;
|
||||
import com.hithomelabs.CFTunnels.Models.TunnelResponse;
|
||||
import com.hithomelabs.CFTunnels.Models.TunnelResult;
|
||||
import com.hithomelabs.CFTunnels.Models.TunnelsResponse;
|
||||
import com.hithomelabs.CFTunnels.Repositories.TunnelRepository;
|
||||
import com.hithomelabs.cftunnels.Config.CloudflareConfig;
|
||||
import com.hithomelabs.cftunnels.Entity.Tunnel;
|
||||
import com.hithomelabs.cftunnels.Exceptions.ExternalServiceException;
|
||||
import com.hithomelabs.cftunnels.Headers.AuthKeyEmailHeader;
|
||||
import com.hithomelabs.cftunnels.Models.Config;
|
||||
import com.hithomelabs.cftunnels.Models.Ingress;
|
||||
import com.hithomelabs.cftunnels.Models.TunnelResponse;
|
||||
import com.hithomelabs.cftunnels.Models.TunnelResult;
|
||||
import com.hithomelabs.cftunnels.Models.TunnelsResponse;
|
||||
import com.hithomelabs.cftunnels.Repositories.TunnelRepository;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.junit.jupiter.api.extension.ExtendWith;
|
||||
import org.mockito.InjectMocks;
|
||||
@ -26,7 +26,7 @@ import java.util.NoSuchElementException;
|
||||
import java.util.Optional;
|
||||
import java.util.UUID;
|
||||
|
||||
import static com.hithomelabs.CFTunnels.TestUtils.Util.getClassPathDataResource;
|
||||
import static com.hithomelabs.cftunnels.TestUtils.Util.getClassPathDataResource;
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.junit.jupiter.api.Assertions.assertThrows;
|
||||
import static org.mockito.ArgumentMatchers.any;
|
||||
@ -1,4 +1,4 @@
|
||||
package com.hithomelabs.CFTunnels.TestUtils;
|
||||
package com.hithomelabs.cftunnels.TestUtils;
|
||||
|
||||
import org.springframework.core.io.ClassPathResource;
|
||||
|
||||
13
common/build.gradle
Normal file
13
common/build.gradle
Normal file
@ -0,0 +1,13 @@
|
||||
dependencies {
|
||||
implementation 'org.springframework:spring-context'
|
||||
implementation 'org.springframework:spring-web'
|
||||
implementation 'com.fasterxml.jackson.core:jackson-databind'
|
||||
implementation 'org.apache.httpcomponents.client5:httpclient5'
|
||||
|
||||
compileOnly 'org.projectlombok:lombok'
|
||||
annotationProcessor 'org.projectlombok:lombok'
|
||||
|
||||
testImplementation 'org.junit.jupiter:junit-jupiter'
|
||||
testImplementation 'org.mockito:mockito-core'
|
||||
testImplementation 'org.springframework.boot:spring-boot-starter-test'
|
||||
}
|
||||
@ -0,0 +1,34 @@
|
||||
package com.hithomelabs.common.config;
|
||||
|
||||
import com.fasterxml.jackson.annotation.JsonInclude;
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import com.fasterxml.jackson.databind.SerializationFeature;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
|
||||
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
|
||||
import org.springframework.web.client.RestTemplate;
|
||||
|
||||
import java.time.Duration;
|
||||
|
||||
@Configuration
|
||||
public class RestTemplateConfig {
|
||||
|
||||
private static final Duration CONNECT_TIMEOUT = Duration.ofSeconds(10);
|
||||
private static final Duration READ_TIMEOUT = Duration.ofSeconds(30);
|
||||
|
||||
@Bean
|
||||
public RestTemplate restTemplate() {
|
||||
HttpComponentsClientHttpRequestFactory factory = new HttpComponentsClientHttpRequestFactory();
|
||||
factory.setConnectTimeout(Math.toIntExact(CONNECT_TIMEOUT.toMillis()));
|
||||
factory.setReadTimeout(Math.toIntExact(READ_TIMEOUT.toMillis()));
|
||||
|
||||
RestTemplate restTemplate = new RestTemplate(factory);
|
||||
MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
|
||||
converter.setObjectMapper(new ObjectMapper()
|
||||
.enable(SerializationFeature.WRAP_ROOT_VALUE)
|
||||
.setSerializationInclusion(JsonInclude.Include.NON_NULL));
|
||||
restTemplate.getMessageConverters().add(0, converter);
|
||||
return restTemplate;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,302 @@
|
||||
package com.hithomelabs.common.portainer.client;
|
||||
|
||||
import com.hithomelabs.common.portainer.client.exception.PortainerAuthenticationException;
|
||||
import com.hithomelabs.common.portainer.client.exception.PortainerConnectionException;
|
||||
import com.hithomelabs.common.portainer.client.exception.PortainerDeploymentException;
|
||||
import com.hithomelabs.common.portainer.client.exception.PortainerResourceNotFoundException;
|
||||
import com.hithomelabs.common.portainer.model.EnvVariable;
|
||||
import com.hithomelabs.common.portainer.model.PortainerAuthRequest;
|
||||
import com.hithomelabs.common.portainer.model.PortainerAuthResponse;
|
||||
import com.hithomelabs.common.portainer.model.PortainerRedeployRequest;
|
||||
import com.hithomelabs.common.portainer.model.PortainerStack;
|
||||
|
||||
import org.springframework.core.ParameterizedTypeReference;
|
||||
import org.springframework.http.HttpEntity;
|
||||
import org.springframework.http.HttpHeaders;
|
||||
import org.springframework.http.HttpMethod;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.http.MediaType;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
import org.springframework.web.client.HttpClientErrorException;
|
||||
import org.springframework.web.client.ResourceAccessException;
|
||||
import org.springframework.web.client.RestClientException;
|
||||
import org.springframework.web.client.RestTemplate;
|
||||
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
import java.util.Optional;
|
||||
|
||||
public class PortainerApiClient {
|
||||
|
||||
private static final String API_AUTH = "/api/auth";
|
||||
private static final String API_STACKS = "/api/stacks";
|
||||
|
||||
private final RestTemplate restTemplate;
|
||||
private final String baseUrl;
|
||||
private String jwtToken;
|
||||
private String apiKey;
|
||||
|
||||
public PortainerApiClient(RestTemplate restTemplate, String baseUrl) {
|
||||
this.restTemplate = restTemplate;
|
||||
// Strip trailing slash if present
|
||||
this.baseUrl = baseUrl != null ? baseUrl.replaceAll("/+$", "") : "";
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------
|
||||
// Authentication
|
||||
// -----------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Authenticate using a Portainer API key (recommended).
|
||||
* The API key is sent as a Bearer token in the Authorization header
|
||||
* for all subsequent requests.
|
||||
*/
|
||||
public void authenticateWithApiKey(String apiKey) {
|
||||
if (apiKey == null || apiKey.isBlank()) {
|
||||
throw new PortainerAuthenticationException("API key must not be null or blank");
|
||||
}
|
||||
this.apiKey = apiKey;
|
||||
// No JWT token needed when using API key auth
|
||||
this.jwtToken = null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Authenticate with username/password credentials (fallback).
|
||||
* Sends a POST to {@code /api/auth} and stores the returned JWT.
|
||||
*/
|
||||
public PortainerAuthResponse authenticateWithPassword(String username, String password) {
|
||||
if (username == null || username.isBlank()) {
|
||||
throw new PortainerAuthenticationException("Username must not be null or blank");
|
||||
}
|
||||
if (password == null || password.isBlank()) {
|
||||
throw new PortainerAuthenticationException("Password must not be null or blank");
|
||||
}
|
||||
|
||||
PortainerAuthRequest request = new PortainerAuthRequest(username, password);
|
||||
HttpHeaders headers = new HttpHeaders();
|
||||
headers.setContentType(MediaType.APPLICATION_JSON);
|
||||
HttpEntity<PortainerAuthRequest> entity = new HttpEntity<>(request, headers);
|
||||
|
||||
try {
|
||||
ResponseEntity<PortainerAuthResponse> response = restTemplate.exchange(
|
||||
baseUrl + API_AUTH,
|
||||
HttpMethod.POST,
|
||||
entity,
|
||||
PortainerAuthResponse.class);
|
||||
|
||||
if (response.getStatusCode() != HttpStatus.OK || response.getBody() == null) {
|
||||
throw new PortainerAuthenticationException(
|
||||
"Authentication failed with status: " + response.getStatusCode());
|
||||
}
|
||||
|
||||
this.jwtToken = response.getBody().getJwt();
|
||||
// Clear any previously set API key
|
||||
this.apiKey = null;
|
||||
return response.getBody();
|
||||
} catch (HttpClientErrorException e) {
|
||||
throw new PortainerAuthenticationException(
|
||||
"Authentication failed: " + e.getStatusCode() + " - " + e.getResponseBodyAsString(), e);
|
||||
} catch (ResourceAccessException e) {
|
||||
throw new PortainerConnectionException(
|
||||
"Unable to connect to Portainer at " + baseUrl + ": " + e.getMessage(), e);
|
||||
}
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------
|
||||
// Stack operations
|
||||
// -----------------------------------------------------------
|
||||
|
||||
/**
|
||||
* List all stacks managed by Portainer.
|
||||
*/
|
||||
public List<PortainerStack> listStacks() {
|
||||
HttpEntity<Void> entity = buildAuthEntity();
|
||||
|
||||
try {
|
||||
ResponseEntity<List<PortainerStack>> response = restTemplate.exchange(
|
||||
baseUrl + API_STACKS,
|
||||
HttpMethod.GET,
|
||||
entity,
|
||||
new ParameterizedTypeReference<>() {});
|
||||
|
||||
if (response.getStatusCode() != HttpStatus.OK || response.getBody() == null) {
|
||||
return Collections.emptyList();
|
||||
}
|
||||
return response.getBody();
|
||||
} catch (HttpClientErrorException e) {
|
||||
if (e.getStatusCode() == HttpStatus.UNAUTHORIZED) {
|
||||
throw new PortainerAuthenticationException(
|
||||
"Not authenticated. Please authenticate before listing stacks.", e);
|
||||
}
|
||||
throw new PortainerDeploymentException(
|
||||
"Failed to list stacks: " + e.getStatusCode() + " - " + e.getResponseBodyAsString(), e);
|
||||
} catch (ResourceAccessException e) {
|
||||
throw new PortainerConnectionException(
|
||||
"Unable to connect to Portainer at " + baseUrl + ": " + e.getMessage(), e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Find a stack by its exact name.
|
||||
*/
|
||||
public Optional<PortainerStack> findStackByName(String name) {
|
||||
if (name == null || name.isBlank()) {
|
||||
return Optional.empty();
|
||||
}
|
||||
|
||||
List<PortainerStack> stacks = listStacks();
|
||||
return stacks.stream()
|
||||
.filter(stack -> name.equals(stack.getName()))
|
||||
.findFirst();
|
||||
}
|
||||
|
||||
/**
|
||||
* Redeploy a standard (non-git) stack.
|
||||
* Sends a PUT to {@code /api/stacks/{stackId}?endpointId={endpointId}}.
|
||||
*/
|
||||
public void redeployStack(Long stackId, Long endpointId, boolean pullImage) {
|
||||
if (stackId == null) {
|
||||
throw new PortainerDeploymentException("Stack ID must not be null");
|
||||
}
|
||||
if (endpointId == null) {
|
||||
throw new PortainerDeploymentException("Endpoint ID must not be null");
|
||||
}
|
||||
|
||||
PortainerRedeployRequest body = new PortainerRedeployRequest(pullImage, true);
|
||||
HttpEntity<PortainerRedeployRequest> entity = new HttpEntity<>(body, buildAuthHeaders());
|
||||
|
||||
try {
|
||||
ResponseEntity<Void> response = restTemplate.exchange(
|
||||
baseUrl + API_STACKS + "/{stackId}?endpointId={endpointId}",
|
||||
HttpMethod.PUT,
|
||||
entity,
|
||||
Void.class,
|
||||
stackId,
|
||||
endpointId);
|
||||
|
||||
if (!response.getStatusCode().is2xxSuccessful()) {
|
||||
throw new PortainerDeploymentException(
|
||||
"Redeploy failed with status: " + response.getStatusCode());
|
||||
}
|
||||
} catch (HttpClientErrorException e) {
|
||||
if (e.getStatusCode() == HttpStatus.UNAUTHORIZED) {
|
||||
throw new PortainerAuthenticationException(
|
||||
"Not authenticated. Please authenticate before redeploying.", e);
|
||||
}
|
||||
if (e.getStatusCode() == HttpStatus.NOT_FOUND) {
|
||||
throw new PortainerResourceNotFoundException(
|
||||
"Stack with ID " + stackId + " not found on endpoint " + endpointId, e);
|
||||
}
|
||||
throw new PortainerDeploymentException(
|
||||
"Failed to redeploy stack " + stackId + ": " + e.getStatusCode()
|
||||
+ " - " + e.getResponseBodyAsString(), e);
|
||||
} catch (ResourceAccessException e) {
|
||||
throw new PortainerConnectionException(
|
||||
"Unable to connect to Portainer at " + baseUrl + ": " + e.getMessage(), e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch a single stack by its ID.
|
||||
*/
|
||||
public PortainerStack getStack(Long stackId) {
|
||||
if (stackId == null) {
|
||||
throw new PortainerDeploymentException("Stack ID must not be null");
|
||||
}
|
||||
HttpEntity<Void> entity = buildAuthEntity();
|
||||
try {
|
||||
ResponseEntity<PortainerStack> response = restTemplate.exchange(
|
||||
baseUrl + API_STACKS + "/{stackId}",
|
||||
HttpMethod.GET,
|
||||
entity,
|
||||
PortainerStack.class,
|
||||
stackId);
|
||||
if (response.getStatusCode() != HttpStatus.OK || response.getBody() == null) {
|
||||
throw new PortainerResourceNotFoundException(
|
||||
"Stack with ID " + stackId + " not found");
|
||||
}
|
||||
return response.getBody();
|
||||
} catch (HttpClientErrorException e) {
|
||||
if (e.getStatusCode() == HttpStatus.UNAUTHORIZED) {
|
||||
throw new PortainerAuthenticationException(
|
||||
"Not authenticated. Please authenticate before fetching stack.", e);
|
||||
}
|
||||
if (e.getStatusCode() == HttpStatus.NOT_FOUND) {
|
||||
throw new PortainerResourceNotFoundException(
|
||||
"Stack with ID " + stackId + " not found", e);
|
||||
}
|
||||
throw new PortainerDeploymentException(
|
||||
"Failed to fetch stack " + stackId + ": " + e.getStatusCode(), e);
|
||||
} catch (ResourceAccessException e) {
|
||||
throw new PortainerConnectionException(
|
||||
"Unable to connect to Portainer at " + baseUrl + ": " + e.getMessage(), e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Redeploy a git-based stack.
|
||||
* Sends a PUT to {@code /api/stacks/{stackId}/git/redeploy?endpointId={endpointId}}.
|
||||
*
|
||||
* @param env optional list of environment variables to pass for compose variable substitution
|
||||
*/
|
||||
public void redeployGitStack(Long stackId, Long endpointId, boolean pullImage, List<EnvVariable> env) {
|
||||
if (stackId == null) {
|
||||
throw new PortainerDeploymentException("Stack ID must not be null");
|
||||
}
|
||||
if (endpointId == null) {
|
||||
throw new PortainerDeploymentException("Endpoint ID must not be null");
|
||||
}
|
||||
|
||||
PortainerRedeployRequest body = new PortainerRedeployRequest(pullImage, false, env);
|
||||
HttpEntity<PortainerRedeployRequest> entity = new HttpEntity<>(body, buildAuthHeaders());
|
||||
|
||||
try {
|
||||
ResponseEntity<Void> response = restTemplate.exchange(
|
||||
baseUrl + API_STACKS + "/{stackId}/git/redeploy?endpointId={endpointId}",
|
||||
HttpMethod.PUT,
|
||||
entity,
|
||||
Void.class,
|
||||
stackId,
|
||||
endpointId);
|
||||
|
||||
if (!response.getStatusCode().is2xxSuccessful()) {
|
||||
throw new PortainerDeploymentException(
|
||||
"Git redeploy failed with status: " + response.getStatusCode());
|
||||
}
|
||||
} catch (HttpClientErrorException e) {
|
||||
if (e.getStatusCode() == HttpStatus.UNAUTHORIZED) {
|
||||
throw new PortainerAuthenticationException(
|
||||
"Not authenticated. Please authenticate before redeploying.", e);
|
||||
}
|
||||
if (e.getStatusCode() == HttpStatus.NOT_FOUND) {
|
||||
throw new PortainerResourceNotFoundException(
|
||||
"Git stack with ID " + stackId + " not found on endpoint " + endpointId, e);
|
||||
}
|
||||
throw new PortainerDeploymentException(
|
||||
"Failed to git-redeploy stack " + stackId + ": " + e.getStatusCode()
|
||||
+ " - " + e.getResponseBodyAsString(), e);
|
||||
} catch (ResourceAccessException e) {
|
||||
throw new PortainerConnectionException(
|
||||
"Unable to connect to Portainer at " + baseUrl + ": " + e.getMessage(), e);
|
||||
}
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------
|
||||
// Internal helpers
|
||||
// -----------------------------------------------------------
|
||||
|
||||
private HttpHeaders buildAuthHeaders() {
|
||||
HttpHeaders headers = new HttpHeaders();
|
||||
headers.setContentType(MediaType.APPLICATION_JSON);
|
||||
if (apiKey != null && !apiKey.isBlank()) {
|
||||
headers.set("X-API-Key", apiKey);
|
||||
} else if (jwtToken != null && !jwtToken.isBlank()) {
|
||||
headers.setBearerAuth(jwtToken);
|
||||
}
|
||||
return headers;
|
||||
}
|
||||
|
||||
private <T> HttpEntity<T> buildAuthEntity() {
|
||||
return new HttpEntity<>(buildAuthHeaders());
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,12 @@
|
||||
package com.hithomelabs.common.portainer.client.exception;
|
||||
|
||||
public class PortainerAuthenticationException extends RuntimeException {
|
||||
|
||||
public PortainerAuthenticationException(String message) {
|
||||
super(message);
|
||||
}
|
||||
|
||||
public PortainerAuthenticationException(String message, Throwable cause) {
|
||||
super(message, cause);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,12 @@
|
||||
package com.hithomelabs.common.portainer.client.exception;
|
||||
|
||||
public class PortainerConnectionException extends RuntimeException {
|
||||
|
||||
public PortainerConnectionException(String message) {
|
||||
super(message);
|
||||
}
|
||||
|
||||
public PortainerConnectionException(String message, Throwable cause) {
|
||||
super(message, cause);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,12 @@
|
||||
package com.hithomelabs.common.portainer.client.exception;
|
||||
|
||||
public class PortainerDeploymentException extends RuntimeException {
|
||||
|
||||
public PortainerDeploymentException(String message) {
|
||||
super(message);
|
||||
}
|
||||
|
||||
public PortainerDeploymentException(String message, Throwable cause) {
|
||||
super(message, cause);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,12 @@
|
||||
package com.hithomelabs.common.portainer.client.exception;
|
||||
|
||||
public class PortainerResourceNotFoundException extends RuntimeException {
|
||||
|
||||
public PortainerResourceNotFoundException(String message) {
|
||||
super(message);
|
||||
}
|
||||
|
||||
public PortainerResourceNotFoundException(String message, Throwable cause) {
|
||||
super(message, cause);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,24 @@
|
||||
package com.hithomelabs.common.portainer.model;
|
||||
|
||||
import com.fasterxml.jackson.annotation.JsonProperty;
|
||||
|
||||
public class EnvVariable {
|
||||
|
||||
@JsonProperty("name")
|
||||
private String name;
|
||||
|
||||
@JsonProperty("value")
|
||||
private String value;
|
||||
|
||||
public EnvVariable() {}
|
||||
|
||||
public EnvVariable(String name, String value) {
|
||||
this.name = name;
|
||||
this.value = value;
|
||||
}
|
||||
|
||||
public String getName() { return name; }
|
||||
public void setName(String name) { this.name = name; }
|
||||
public String getValue() { return value; }
|
||||
public void setValue(String value) { this.value = value; }
|
||||
}
|
||||
@ -0,0 +1,35 @@
|
||||
package com.hithomelabs.common.portainer.model;
|
||||
|
||||
import com.fasterxml.jackson.annotation.JsonProperty;
|
||||
|
||||
public class PortainerAuthRequest {
|
||||
|
||||
@JsonProperty("Username")
|
||||
private String username;
|
||||
|
||||
@JsonProperty("Password")
|
||||
private String password;
|
||||
|
||||
public PortainerAuthRequest() {}
|
||||
|
||||
public PortainerAuthRequest(String username, String password) {
|
||||
this.username = username;
|
||||
this.password = password;
|
||||
}
|
||||
|
||||
public String getUsername() {
|
||||
return username;
|
||||
}
|
||||
|
||||
public void setUsername(String username) {
|
||||
this.username = username;
|
||||
}
|
||||
|
||||
public String getPassword() {
|
||||
return password;
|
||||
}
|
||||
|
||||
public void setPassword(String password) {
|
||||
this.password = password;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,19 @@
|
||||
package com.hithomelabs.common.portainer.model;
|
||||
|
||||
import com.fasterxml.jackson.annotation.JsonProperty;
|
||||
|
||||
public class PortainerAuthResponse {
|
||||
|
||||
@JsonProperty("jwt")
|
||||
private String jwt;
|
||||
|
||||
public PortainerAuthResponse() {}
|
||||
|
||||
public String getJwt() {
|
||||
return jwt;
|
||||
}
|
||||
|
||||
public void setJwt(String jwt) {
|
||||
this.jwt = jwt;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,54 @@
|
||||
package com.hithomelabs.common.portainer.model;
|
||||
|
||||
import com.fasterxml.jackson.annotation.JsonProperty;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
public class PortainerRedeployRequest {
|
||||
|
||||
@JsonProperty("PullImage")
|
||||
private boolean pullImage;
|
||||
|
||||
@JsonProperty("Prune")
|
||||
private boolean prune;
|
||||
|
||||
@JsonProperty("Env")
|
||||
private List<EnvVariable> env;
|
||||
|
||||
public PortainerRedeployRequest() {}
|
||||
|
||||
public PortainerRedeployRequest(boolean pullImage, boolean prune) {
|
||||
this.pullImage = pullImage;
|
||||
this.prune = prune;
|
||||
}
|
||||
|
||||
public PortainerRedeployRequest(boolean pullImage, boolean prune, List<EnvVariable> env) {
|
||||
this.pullImage = pullImage;
|
||||
this.prune = prune;
|
||||
this.env = env;
|
||||
}
|
||||
|
||||
public boolean isPullImage() {
|
||||
return pullImage;
|
||||
}
|
||||
|
||||
public void setPullImage(boolean pullImage) {
|
||||
this.pullImage = pullImage;
|
||||
}
|
||||
|
||||
public boolean isPrune() {
|
||||
return prune;
|
||||
}
|
||||
|
||||
public void setPrune(boolean prune) {
|
||||
this.prune = prune;
|
||||
}
|
||||
|
||||
public List<EnvVariable> getEnv() {
|
||||
return env;
|
||||
}
|
||||
|
||||
public void setEnv(List<EnvVariable> env) {
|
||||
this.env = env;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,77 @@
|
||||
package com.hithomelabs.common.portainer.model;
|
||||
|
||||
import com.fasterxml.jackson.annotation.JsonProperty;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
public class PortainerStack {
|
||||
|
||||
@JsonProperty("Id")
|
||||
private Long id;
|
||||
|
||||
@JsonProperty("Name")
|
||||
private String name;
|
||||
|
||||
@JsonProperty("EndpointId")
|
||||
private Long endpointId;
|
||||
|
||||
@JsonProperty("Status")
|
||||
private int status;
|
||||
|
||||
@JsonProperty("ResourceControl")
|
||||
private Map<String, Object> resourceControl;
|
||||
|
||||
@JsonProperty("Env")
|
||||
private List<EnvVariable> env;
|
||||
|
||||
public PortainerStack() {}
|
||||
|
||||
public Long getId() {
|
||||
return id;
|
||||
}
|
||||
|
||||
public void setId(Long id) {
|
||||
this.id = id;
|
||||
}
|
||||
|
||||
public String getName() {
|
||||
return name;
|
||||
}
|
||||
|
||||
public void setName(String name) {
|
||||
this.name = name;
|
||||
}
|
||||
|
||||
public Long getEndpointId() {
|
||||
return endpointId;
|
||||
}
|
||||
|
||||
public void setEndpointId(Long endpointId) {
|
||||
this.endpointId = endpointId;
|
||||
}
|
||||
|
||||
public int getStatus() {
|
||||
return status;
|
||||
}
|
||||
|
||||
public void setStatus(int status) {
|
||||
this.status = status;
|
||||
}
|
||||
|
||||
public Map<String, Object> getResourceControl() {
|
||||
return resourceControl;
|
||||
}
|
||||
|
||||
public void setResourceControl(Map<String, Object> resourceControl) {
|
||||
this.resourceControl = resourceControl;
|
||||
}
|
||||
|
||||
public List<EnvVariable> getEnv() {
|
||||
return env;
|
||||
}
|
||||
|
||||
public void setEnv(List<EnvVariable> env) {
|
||||
this.env = env;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,65 @@
|
||||
package com.hithomelabs.common.registry.model;
|
||||
|
||||
import java.util.regex.Matcher;
|
||||
import java.util.regex.Pattern;
|
||||
|
||||
public class ImageReference {
|
||||
|
||||
private static final Pattern IMAGE_PATTERN =
|
||||
Pattern.compile("^(?<registry>[^/]+)/(?<repository>[^:]+):(?<tag>.+)$");
|
||||
|
||||
private final String registry;
|
||||
private final String repository;
|
||||
private final String tag;
|
||||
private final String fullImage;
|
||||
|
||||
private ImageReference(String registry, String repository, String tag, String fullImage) {
|
||||
this.registry = registry;
|
||||
this.repository = repository;
|
||||
this.tag = tag;
|
||||
this.fullImage = fullImage;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses a container image reference string of the form:
|
||||
* {@code registry/repository:tag}
|
||||
* e.g. {@code 192.168.0.100:8928/hithomelabs/cftunnels:1.2.3}
|
||||
*
|
||||
* @param image the full image reference string
|
||||
* @return a parsed {@code ImageReference}
|
||||
* @throws IllegalArgumentException if the string cannot be parsed
|
||||
*/
|
||||
public static ImageReference parse(String image) {
|
||||
if (image == null || image.isBlank()) {
|
||||
throw new IllegalArgumentException("Image reference must not be null or blank");
|
||||
}
|
||||
|
||||
Matcher matcher = IMAGE_PATTERN.matcher(image);
|
||||
if (!matcher.matches()) {
|
||||
throw new IllegalArgumentException(
|
||||
"Invalid image reference format. Expected '<registry>/<repository>:<tag>', got: " + image);
|
||||
}
|
||||
|
||||
String registry = matcher.group("registry");
|
||||
String repository = matcher.group("repository");
|
||||
String tag = matcher.group("tag");
|
||||
|
||||
return new ImageReference(registry, repository, tag, image);
|
||||
}
|
||||
|
||||
public String getRegistry() {
|
||||
return registry;
|
||||
}
|
||||
|
||||
public String getRepository() {
|
||||
return repository;
|
||||
}
|
||||
|
||||
public String getTag() {
|
||||
return tag;
|
||||
}
|
||||
|
||||
public String getFullImage() {
|
||||
return fullImage;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,505 @@
|
||||
package com.hithomelabs.common.portainer.client;
|
||||
|
||||
import com.hithomelabs.common.portainer.client.exception.PortainerAuthenticationException;
|
||||
import com.hithomelabs.common.portainer.client.exception.PortainerConnectionException;
|
||||
import com.hithomelabs.common.portainer.client.exception.PortainerDeploymentException;
|
||||
import com.hithomelabs.common.portainer.client.exception.PortainerResourceNotFoundException;
|
||||
import com.hithomelabs.common.portainer.model.EnvVariable;
|
||||
import com.hithomelabs.common.portainer.model.PortainerAuthRequest;
|
||||
import com.hithomelabs.common.portainer.model.PortainerAuthResponse;
|
||||
import com.hithomelabs.common.portainer.model.PortainerRedeployRequest;
|
||||
import com.hithomelabs.common.portainer.model.PortainerStack;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.junit.jupiter.api.extension.ExtendWith;
|
||||
import org.mockito.ArgumentCaptor;
|
||||
import org.mockito.Mock;
|
||||
import org.mockito.junit.jupiter.MockitoExtension;
|
||||
import org.springframework.http.*;
|
||||
import org.springframework.web.client.HttpClientErrorException;
|
||||
import org.springframework.web.client.ResourceAccessException;
|
||||
import org.springframework.web.client.RestTemplate;
|
||||
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.util.List;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
import static org.mockito.ArgumentMatchers.*;
|
||||
import static org.mockito.Mockito.*;
|
||||
|
||||
@ExtendWith(MockitoExtension.class)
|
||||
class PortainerApiClientTest {
|
||||
|
||||
@Mock
|
||||
private RestTemplate restTemplate;
|
||||
|
||||
private PortainerApiClient client;
|
||||
|
||||
private static final String BASE_URL = "http://portainer.local:9000";
|
||||
|
||||
@BeforeEach
|
||||
void setUp() {
|
||||
client = new PortainerApiClient(restTemplate, BASE_URL);
|
||||
}
|
||||
|
||||
// -- authenticateWithPassword: success path --
|
||||
|
||||
@Test
|
||||
void authenticateWithPassword_validCredentials_returnsAuthResponse() {
|
||||
PortainerAuthResponse authResponse = new PortainerAuthResponse();
|
||||
authResponse.setJwt("test-jwt-token");
|
||||
|
||||
ResponseEntity<PortainerAuthResponse> responseEntity = new ResponseEntity<>(
|
||||
authResponse, HttpStatus.OK);
|
||||
|
||||
when(restTemplate.exchange(
|
||||
eq(BASE_URL + "/api/auth"),
|
||||
eq(HttpMethod.POST),
|
||||
any(HttpEntity.class),
|
||||
eq(PortainerAuthResponse.class)))
|
||||
.thenReturn(responseEntity);
|
||||
|
||||
PortainerAuthResponse result = client.authenticateWithPassword("admin", "password123");
|
||||
|
||||
assertNotNull(result);
|
||||
assertEquals("test-jwt-token", result.getJwt());
|
||||
verify(restTemplate).exchange(
|
||||
eq(BASE_URL + "/api/auth"),
|
||||
eq(HttpMethod.POST),
|
||||
any(HttpEntity.class),
|
||||
eq(PortainerAuthResponse.class));
|
||||
}
|
||||
|
||||
// -- authenticateWithPassword: input validation --
|
||||
|
||||
@Test
|
||||
void authenticateWithPassword_nullUsername_throwsException() {
|
||||
assertThrows(PortainerAuthenticationException.class,
|
||||
() -> client.authenticateWithPassword(null, "password"));
|
||||
verifyNoInteractions(restTemplate);
|
||||
}
|
||||
|
||||
@Test
|
||||
void authenticateWithPassword_blankUsername_throwsException() {
|
||||
assertThrows(PortainerAuthenticationException.class,
|
||||
() -> client.authenticateWithPassword(" ", "password"));
|
||||
verifyNoInteractions(restTemplate);
|
||||
}
|
||||
|
||||
@Test
|
||||
void authenticateWithPassword_nullPassword_throwsException() {
|
||||
assertThrows(PortainerAuthenticationException.class,
|
||||
() -> client.authenticateWithPassword("admin", null));
|
||||
verifyNoInteractions(restTemplate);
|
||||
}
|
||||
|
||||
@Test
|
||||
void authenticateWithPassword_blankPassword_throwsException() {
|
||||
assertThrows(PortainerAuthenticationException.class,
|
||||
() -> client.authenticateWithPassword("admin", " "));
|
||||
verifyNoInteractions(restTemplate);
|
||||
}
|
||||
|
||||
// -- authenticateWithPassword: HTTP error handling --
|
||||
|
||||
@Test
|
||||
void authenticateWithPassword_http401_throwsAuthenticationException() {
|
||||
when(restTemplate.exchange(
|
||||
anyString(),
|
||||
eq(HttpMethod.POST),
|
||||
any(HttpEntity.class),
|
||||
eq(PortainerAuthResponse.class)))
|
||||
.thenThrow(HttpClientErrorException.create(
|
||||
HttpStatus.UNAUTHORIZED,
|
||||
"Unauthorized",
|
||||
HttpHeaders.EMPTY,
|
||||
"Bad credentials".getBytes(StandardCharsets.UTF_8),
|
||||
StandardCharsets.UTF_8));
|
||||
|
||||
PortainerAuthenticationException ex = assertThrows(PortainerAuthenticationException.class,
|
||||
() -> client.authenticateWithPassword("admin", "wrong"));
|
||||
assertTrue(ex.getMessage().contains("401"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void authenticateWithPassword_http403_throwsAuthenticationException() {
|
||||
when(restTemplate.exchange(
|
||||
anyString(),
|
||||
eq(HttpMethod.POST),
|
||||
any(HttpEntity.class),
|
||||
eq(PortainerAuthResponse.class)))
|
||||
.thenThrow(HttpClientErrorException.create(
|
||||
HttpStatus.FORBIDDEN,
|
||||
"Forbidden",
|
||||
HttpHeaders.EMPTY,
|
||||
"Forbidden".getBytes(StandardCharsets.UTF_8),
|
||||
StandardCharsets.UTF_8));
|
||||
|
||||
assertThrows(PortainerAuthenticationException.class,
|
||||
() -> client.authenticateWithPassword("admin", "wrong"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void authenticateWithPassword_connectionError_throwsConnectionException() {
|
||||
when(restTemplate.exchange(
|
||||
anyString(),
|
||||
eq(HttpMethod.POST),
|
||||
any(HttpEntity.class),
|
||||
eq(PortainerAuthResponse.class)))
|
||||
.thenThrow(new ResourceAccessException("Connection refused"));
|
||||
|
||||
PortainerConnectionException ex = assertThrows(PortainerConnectionException.class,
|
||||
() -> client.authenticateWithPassword("admin", "password"));
|
||||
assertTrue(ex.getMessage().contains(BASE_URL));
|
||||
assertTrue(ex.getMessage().contains("Connection refused"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void authenticateWithPassword_nonOkStatus_throwsAuthenticationException() {
|
||||
PortainerAuthResponse authResponse = new PortainerAuthResponse();
|
||||
authResponse.setJwt("token");
|
||||
// Return a non-OK status with null body to trigger the status check path
|
||||
ResponseEntity<PortainerAuthResponse> responseEntity = new ResponseEntity<>(
|
||||
null, HttpStatus.INTERNAL_SERVER_ERROR);
|
||||
|
||||
when(restTemplate.exchange(
|
||||
anyString(),
|
||||
eq(HttpMethod.POST),
|
||||
any(HttpEntity.class),
|
||||
eq(PortainerAuthResponse.class)))
|
||||
.thenReturn(responseEntity);
|
||||
|
||||
PortainerAuthenticationException ex = assertThrows(PortainerAuthenticationException.class,
|
||||
() -> client.authenticateWithPassword("admin", "password"));
|
||||
assertTrue(ex.getMessage().contains("500"));
|
||||
}
|
||||
|
||||
// -- authenticateWithApiKey: input validation --
|
||||
|
||||
@Test
|
||||
void authenticateWithApiKey_nullKey_throwsException() {
|
||||
assertThrows(PortainerAuthenticationException.class,
|
||||
() -> client.authenticateWithApiKey(null));
|
||||
verifyNoInteractions(restTemplate);
|
||||
}
|
||||
|
||||
@Test
|
||||
void authenticateWithApiKey_blankKey_throwsException() {
|
||||
assertThrows(PortainerAuthenticationException.class,
|
||||
() -> client.authenticateWithApiKey(" "));
|
||||
verifyNoInteractions(restTemplate);
|
||||
}
|
||||
|
||||
@Test
|
||||
void authenticateWithApiKey_validKey_setsApiKey() {
|
||||
client.authenticateWithApiKey("ptr_abc123def456");
|
||||
// No exception expected; we verify it doesn't throw
|
||||
// We can test this by calling a subsequent method that uses the API key
|
||||
assertDoesNotThrow(() -> client.authenticateWithApiKey("ptr_abc123def456"));
|
||||
}
|
||||
|
||||
// -- Constructor: trailing slash handling --
|
||||
|
||||
@Test
|
||||
void constructor_withTrailingSlash_stripsIt() {
|
||||
PortainerApiClient clientWithSlash = new PortainerApiClient(restTemplate, "http://portainer.local:9000/");
|
||||
// authenticateWithPassword should use the stripped URL
|
||||
PortainerAuthResponse authResponse = new PortainerAuthResponse();
|
||||
authResponse.setJwt("token");
|
||||
ResponseEntity<PortainerAuthResponse> responseEntity = new ResponseEntity<>(
|
||||
authResponse, HttpStatus.OK);
|
||||
|
||||
when(restTemplate.exchange(
|
||||
eq("http://portainer.local:9000/api/auth"),
|
||||
eq(HttpMethod.POST),
|
||||
any(HttpEntity.class),
|
||||
eq(PortainerAuthResponse.class)))
|
||||
.thenReturn(responseEntity);
|
||||
|
||||
PortainerAuthResponse result = clientWithSlash.authenticateWithPassword("admin", "pass");
|
||||
assertNotNull(result);
|
||||
assertEquals("token", result.getJwt());
|
||||
}
|
||||
|
||||
@Test
|
||||
void constructor_withNullBaseUrl_usesEmptyString() {
|
||||
PortainerApiClient clientNullUrl = new PortainerApiClient(restTemplate, null);
|
||||
// Should not throw; the client is created with an empty base URL
|
||||
assertDoesNotThrow(() -> clientNullUrl.authenticateWithApiKey("key"));
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------
|
||||
// getStack
|
||||
// -----------------------------------------------------------
|
||||
|
||||
@Test
|
||||
void getStack_success_returnsPortainerStack() {
|
||||
PortainerStack expected = new PortainerStack();
|
||||
expected.setId(1L);
|
||||
expected.setName("test-stack");
|
||||
ResponseEntity<PortainerStack> responseEntity = new ResponseEntity<>(expected, HttpStatus.OK);
|
||||
|
||||
when(restTemplate.exchange(
|
||||
anyString(),
|
||||
eq(HttpMethod.GET),
|
||||
any(HttpEntity.class),
|
||||
eq(PortainerStack.class),
|
||||
anyLong()))
|
||||
.thenReturn(responseEntity);
|
||||
|
||||
PortainerStack result = client.getStack(1L);
|
||||
assertNotNull(result);
|
||||
assertEquals(1L, result.getId());
|
||||
assertEquals("test-stack", result.getName());
|
||||
}
|
||||
|
||||
@Test
|
||||
void getStack_nullId_throwsException() {
|
||||
assertThrows(PortainerDeploymentException.class,
|
||||
() -> client.getStack(null));
|
||||
verifyNoInteractions(restTemplate);
|
||||
}
|
||||
|
||||
@Test
|
||||
void getStack_http404_throwsResourceNotFoundException() {
|
||||
when(restTemplate.exchange(
|
||||
anyString(),
|
||||
eq(HttpMethod.GET),
|
||||
any(HttpEntity.class),
|
||||
eq(PortainerStack.class),
|
||||
anyLong()))
|
||||
.thenThrow(HttpClientErrorException.create(
|
||||
HttpStatus.NOT_FOUND,
|
||||
"Not Found",
|
||||
HttpHeaders.EMPTY,
|
||||
"Stack not found".getBytes(StandardCharsets.UTF_8),
|
||||
StandardCharsets.UTF_8));
|
||||
|
||||
assertThrows(PortainerResourceNotFoundException.class,
|
||||
() -> client.getStack(1L));
|
||||
}
|
||||
|
||||
@Test
|
||||
void getStack_http401_throwsAuthenticationException() {
|
||||
when(restTemplate.exchange(
|
||||
anyString(),
|
||||
eq(HttpMethod.GET),
|
||||
any(HttpEntity.class),
|
||||
eq(PortainerStack.class),
|
||||
anyLong()))
|
||||
.thenThrow(HttpClientErrorException.create(
|
||||
HttpStatus.UNAUTHORIZED,
|
||||
"Unauthorized",
|
||||
HttpHeaders.EMPTY,
|
||||
"Not authenticated".getBytes(StandardCharsets.UTF_8),
|
||||
StandardCharsets.UTF_8));
|
||||
|
||||
assertThrows(PortainerAuthenticationException.class,
|
||||
() -> client.getStack(1L));
|
||||
}
|
||||
|
||||
@Test
|
||||
void getStack_connectionError_throwsConnectionException() {
|
||||
when(restTemplate.exchange(
|
||||
anyString(),
|
||||
eq(HttpMethod.GET),
|
||||
any(HttpEntity.class),
|
||||
eq(PortainerStack.class),
|
||||
anyLong()))
|
||||
.thenThrow(new ResourceAccessException("Connection refused"));
|
||||
|
||||
PortainerConnectionException ex = assertThrows(PortainerConnectionException.class,
|
||||
() -> client.getStack(1L));
|
||||
assertTrue(ex.getMessage().contains(BASE_URL));
|
||||
}
|
||||
|
||||
@Test
|
||||
void getStack_nonOkStatus_throwsResourceNotFoundException() {
|
||||
ResponseEntity<PortainerStack> responseEntity = new ResponseEntity<>(null, HttpStatus.NO_CONTENT);
|
||||
|
||||
when(restTemplate.exchange(
|
||||
anyString(),
|
||||
eq(HttpMethod.GET),
|
||||
any(HttpEntity.class),
|
||||
eq(PortainerStack.class),
|
||||
anyLong()))
|
||||
.thenReturn(responseEntity);
|
||||
|
||||
assertThrows(PortainerResourceNotFoundException.class,
|
||||
() -> client.getStack(1L));
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------
|
||||
// redeployGitStack
|
||||
// -----------------------------------------------------------
|
||||
|
||||
@Test
|
||||
void redeployGitStack_success_returnsNormally() {
|
||||
ResponseEntity<Void> responseEntity = new ResponseEntity<>(HttpStatus.OK);
|
||||
|
||||
when(restTemplate.exchange(
|
||||
anyString(),
|
||||
eq(HttpMethod.PUT),
|
||||
any(HttpEntity.class),
|
||||
eq(Void.class),
|
||||
anyLong(),
|
||||
anyLong()))
|
||||
.thenReturn(responseEntity);
|
||||
|
||||
assertDoesNotThrow(() -> client.redeployGitStack(1L, 2L, true, null));
|
||||
}
|
||||
|
||||
@Test
|
||||
void redeployGitStack_withEnvList_containsEnvInRequestBody() {
|
||||
List<EnvVariable> envList = List.of(new EnvVariable("DB_HOST", "postgres"));
|
||||
ResponseEntity<Void> responseEntity = new ResponseEntity<>(HttpStatus.OK);
|
||||
|
||||
when(restTemplate.exchange(
|
||||
anyString(),
|
||||
eq(HttpMethod.PUT),
|
||||
any(HttpEntity.class),
|
||||
eq(Void.class),
|
||||
anyLong(),
|
||||
anyLong()))
|
||||
.thenReturn(responseEntity);
|
||||
|
||||
client.redeployGitStack(1L, 2L, true, envList);
|
||||
|
||||
// Capture the request body to verify Env is included
|
||||
ArgumentCaptor<HttpEntity<PortainerRedeployRequest>> captor = ArgumentCaptor.forClass(HttpEntity.class);
|
||||
verify(restTemplate).exchange(
|
||||
anyString(),
|
||||
eq(HttpMethod.PUT),
|
||||
captor.capture(),
|
||||
eq(Void.class),
|
||||
anyLong(),
|
||||
anyLong());
|
||||
|
||||
PortainerRedeployRequest capturedBody = captor.getValue().getBody();
|
||||
assertNotNull(capturedBody);
|
||||
assertTrue(capturedBody.isPullImage());
|
||||
assertFalse(capturedBody.isPrune());
|
||||
assertNotNull(capturedBody.getEnv());
|
||||
assertEquals(1, capturedBody.getEnv().size());
|
||||
assertEquals("DB_HOST", capturedBody.getEnv().get(0).getName());
|
||||
assertEquals("postgres", capturedBody.getEnv().get(0).getValue());
|
||||
}
|
||||
|
||||
@Test
|
||||
void redeployGitStack_withNullEnv_requestBodyHasNullEnv() {
|
||||
ResponseEntity<Void> responseEntity = new ResponseEntity<>(HttpStatus.OK);
|
||||
|
||||
when(restTemplate.exchange(
|
||||
anyString(),
|
||||
eq(HttpMethod.PUT),
|
||||
any(HttpEntity.class),
|
||||
eq(Void.class),
|
||||
anyLong(),
|
||||
anyLong()))
|
||||
.thenReturn(responseEntity);
|
||||
|
||||
client.redeployGitStack(1L, 2L, false, null);
|
||||
|
||||
ArgumentCaptor<HttpEntity<PortainerRedeployRequest>> captor = ArgumentCaptor.forClass(HttpEntity.class);
|
||||
verify(restTemplate).exchange(
|
||||
anyString(),
|
||||
eq(HttpMethod.PUT),
|
||||
captor.capture(),
|
||||
eq(Void.class),
|
||||
anyLong(),
|
||||
anyLong());
|
||||
|
||||
PortainerRedeployRequest capturedBody = captor.getValue().getBody();
|
||||
assertNotNull(capturedBody);
|
||||
assertFalse(capturedBody.isPullImage());
|
||||
assertFalse(capturedBody.isPrune());
|
||||
assertNull(capturedBody.getEnv());
|
||||
}
|
||||
|
||||
@Test
|
||||
void redeployGitStack_nullId_throwsException() {
|
||||
assertThrows(PortainerDeploymentException.class,
|
||||
() -> client.redeployGitStack(null, 2L, true, null));
|
||||
verifyNoInteractions(restTemplate);
|
||||
}
|
||||
|
||||
@Test
|
||||
void redeployGitStack_nullEndpointId_throwsException() {
|
||||
assertThrows(PortainerDeploymentException.class,
|
||||
() -> client.redeployGitStack(1L, null, true, null));
|
||||
verifyNoInteractions(restTemplate);
|
||||
}
|
||||
|
||||
@Test
|
||||
void redeployGitStack_http404_throwsResourceNotFoundException() {
|
||||
when(restTemplate.exchange(
|
||||
anyString(),
|
||||
eq(HttpMethod.PUT),
|
||||
any(HttpEntity.class),
|
||||
eq(Void.class),
|
||||
anyLong(),
|
||||
anyLong()))
|
||||
.thenThrow(HttpClientErrorException.create(
|
||||
HttpStatus.NOT_FOUND,
|
||||
"Not Found",
|
||||
HttpHeaders.EMPTY,
|
||||
"Stack not found".getBytes(StandardCharsets.UTF_8),
|
||||
StandardCharsets.UTF_8));
|
||||
|
||||
assertThrows(PortainerResourceNotFoundException.class,
|
||||
() -> client.redeployGitStack(1L, 2L, true, null));
|
||||
}
|
||||
|
||||
@Test
|
||||
void redeployGitStack_http401_throwsAuthenticationException() {
|
||||
when(restTemplate.exchange(
|
||||
anyString(),
|
||||
eq(HttpMethod.PUT),
|
||||
any(HttpEntity.class),
|
||||
eq(Void.class),
|
||||
anyLong(),
|
||||
anyLong()))
|
||||
.thenThrow(HttpClientErrorException.create(
|
||||
HttpStatus.UNAUTHORIZED,
|
||||
"Unauthorized",
|
||||
HttpHeaders.EMPTY,
|
||||
"Not authenticated".getBytes(StandardCharsets.UTF_8),
|
||||
StandardCharsets.UTF_8));
|
||||
|
||||
assertThrows(PortainerAuthenticationException.class,
|
||||
() -> client.redeployGitStack(1L, 2L, true, null));
|
||||
}
|
||||
|
||||
@Test
|
||||
void redeployGitStack_connectionError_throwsConnectionException() {
|
||||
when(restTemplate.exchange(
|
||||
anyString(),
|
||||
eq(HttpMethod.PUT),
|
||||
any(HttpEntity.class),
|
||||
eq(Void.class),
|
||||
anyLong(),
|
||||
anyLong()))
|
||||
.thenThrow(new ResourceAccessException("Connection refused"));
|
||||
|
||||
PortainerConnectionException ex = assertThrows(PortainerConnectionException.class,
|
||||
() -> client.redeployGitStack(1L, 2L, true, null));
|
||||
assertTrue(ex.getMessage().contains(BASE_URL));
|
||||
}
|
||||
|
||||
@Test
|
||||
void redeployGitStack_nonOkStatus_throwsDeploymentException() {
|
||||
ResponseEntity<Void> responseEntity = new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);
|
||||
|
||||
when(restTemplate.exchange(
|
||||
anyString(),
|
||||
eq(HttpMethod.PUT),
|
||||
any(HttpEntity.class),
|
||||
eq(Void.class),
|
||||
anyLong(),
|
||||
anyLong()))
|
||||
.thenReturn(responseEntity);
|
||||
|
||||
assertThrows(PortainerDeploymentException.class,
|
||||
() -> client.redeployGitStack(1L, 2L, true, null));
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,66 @@
|
||||
package com.hithomelabs.common.portainer.model;
|
||||
|
||||
import com.fasterxml.jackson.core.JsonProcessingException;
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
|
||||
class EnvVariableTest {
|
||||
|
||||
private final ObjectMapper mapper = new ObjectMapper();
|
||||
|
||||
@Test
|
||||
void serialize() throws JsonProcessingException {
|
||||
EnvVariable env = new EnvVariable("FOO", "bar");
|
||||
String json = mapper.writeValueAsString(env);
|
||||
assertEquals("{\"name\":\"FOO\",\"value\":\"bar\"}", json);
|
||||
}
|
||||
|
||||
@Test
|
||||
void deserialize() throws JsonProcessingException {
|
||||
String json = "{\"name\":\"FOO\",\"value\":\"bar\"}";
|
||||
EnvVariable env = mapper.readValue(json, EnvVariable.class);
|
||||
assertEquals("FOO", env.getName());
|
||||
assertEquals("bar", env.getValue());
|
||||
}
|
||||
|
||||
@Test
|
||||
void nullName() throws JsonProcessingException {
|
||||
EnvVariable env = new EnvVariable(null, "value");
|
||||
String json = mapper.writeValueAsString(env);
|
||||
assertEquals("{\"name\":null,\"value\":\"value\"}", json);
|
||||
}
|
||||
|
||||
@Test
|
||||
void nullValue() throws JsonProcessingException {
|
||||
EnvVariable env = new EnvVariable("name", null);
|
||||
String json = mapper.writeValueAsString(env);
|
||||
assertEquals("{\"name\":\"name\",\"value\":null}", json);
|
||||
}
|
||||
|
||||
@Test
|
||||
void roundTripWithNulls() throws JsonProcessingException {
|
||||
EnvVariable env = new EnvVariable(null, null);
|
||||
String json = mapper.writeValueAsString(env);
|
||||
EnvVariable deserialized = mapper.readValue(json, EnvVariable.class);
|
||||
assertNull(deserialized.getName());
|
||||
assertNull(deserialized.getValue());
|
||||
}
|
||||
|
||||
@Test
|
||||
void constructorAndGetters() {
|
||||
EnvVariable env = new EnvVariable("KEY", "val");
|
||||
assertEquals("KEY", env.getName());
|
||||
assertEquals("val", env.getValue());
|
||||
}
|
||||
|
||||
@Test
|
||||
void setters() {
|
||||
EnvVariable env = new EnvVariable();
|
||||
env.setName("A");
|
||||
env.setValue("B");
|
||||
assertEquals("A", env.getName());
|
||||
assertEquals("B", env.getValue());
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,121 @@
|
||||
package com.hithomelabs.common.portainer.model;
|
||||
|
||||
import com.fasterxml.jackson.core.JsonProcessingException;
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
|
||||
/**
|
||||
* Full round-trip contract test for Portainer model serialization.
|
||||
* <p>
|
||||
* Takes a realistic Portainer API JSON response, deserializes into
|
||||
* {@link PortainerStack}, extracts the env list, creates a
|
||||
* {@link PortainerRedeployRequest} with it, serializes back to JSON,
|
||||
* and asserts the correct structure and values.
|
||||
*/
|
||||
class ModelSerializationTest {
|
||||
|
||||
private final ObjectMapper mapper = new ObjectMapper();
|
||||
|
||||
@Test
|
||||
void fullEnvRoundTrip() throws JsonProcessingException {
|
||||
// Step 1: Realistic Portainer API JSON response with Env array and ResourceControl
|
||||
String portainerJson = """
|
||||
{
|
||||
"Id": 42,
|
||||
"Name": "my-app-stack",
|
||||
"EndpointId": 2,
|
||||
"Status": 1,
|
||||
"Env": [
|
||||
{"name":"DB_HOST","value":"postgres.internal"},
|
||||
{"name":"DB_PORT","value":"5432"},
|
||||
{"name":"REDIS_URL","value":"redis://cache:6379"}
|
||||
],
|
||||
"ResourceControl": {
|
||||
"Id": 1,
|
||||
"Type": 2,
|
||||
"Owner": "admin"
|
||||
}
|
||||
}
|
||||
""";
|
||||
|
||||
// Step 2: Deserialize into PortainerStack
|
||||
PortainerStack stack = mapper.readValue(portainerJson, PortainerStack.class);
|
||||
assertNotNull(stack, "Deserialized stack must not be null");
|
||||
assertEquals(42L, stack.getId().longValue());
|
||||
assertEquals("my-app-stack", stack.getName());
|
||||
assertNotNull(stack.getResourceControl());
|
||||
assertEquals(1, stack.getResourceControl().get("Id"));
|
||||
|
||||
// Step 3: Extract the env list
|
||||
List<EnvVariable> envList = stack.getEnv();
|
||||
assertNotNull(envList, "Env list must not be null");
|
||||
assertEquals(3, envList.size());
|
||||
assertEquals("DB_HOST", envList.get(0).getName());
|
||||
assertEquals("postgres.internal", envList.get(0).getValue());
|
||||
assertEquals("DB_PORT", envList.get(1).getName());
|
||||
assertEquals("5432", envList.get(1).getValue());
|
||||
assertEquals("REDIS_URL", envList.get(2).getName());
|
||||
assertEquals("redis://cache:6379", envList.get(2).getValue());
|
||||
|
||||
// Step 4: Create a PortainerRedeployRequest with that env list (3-arg constructor)
|
||||
PortainerRedeployRequest redeployRequest = new PortainerRedeployRequest(true, false, envList);
|
||||
|
||||
// Step 5: Serialize it back to JSON
|
||||
String requestJson = mapper.writeValueAsString(redeployRequest);
|
||||
|
||||
// Step 6: Assert JSON contains correct key/value pairs
|
||||
// Assert top-level fields
|
||||
assertTrue(requestJson.contains("\"PullImage\":true"),
|
||||
"JSON must contain PullImage:true");
|
||||
assertTrue(requestJson.contains("\"Prune\":false"),
|
||||
"JSON must contain Prune:false");
|
||||
|
||||
// Assert the Env array is present
|
||||
assertTrue(requestJson.contains("\"Env\""),
|
||||
"JSON must contain Env field");
|
||||
|
||||
// Assert correct name/value casing (JsonProperty annotations)
|
||||
assertTrue(requestJson.contains("\"name\":\"DB_HOST\""),
|
||||
"JSON must contain name:DB_HOST");
|
||||
assertTrue(requestJson.contains("\"value\":\"postgres.internal\""),
|
||||
"JSON must contain value:postgres.internal");
|
||||
assertTrue(requestJson.contains("\"name\":\"DB_PORT\""),
|
||||
"JSON must contain name:DB_PORT");
|
||||
assertTrue(requestJson.contains("\"value\":\"5432\""),
|
||||
"JSON must contain value:5432");
|
||||
assertTrue(requestJson.contains("\"name\":\"REDIS_URL\""),
|
||||
"JSON must contain name:REDIS_URL");
|
||||
assertTrue(requestJson.contains("\"value\":\"redis://cache:6379\""),
|
||||
"JSON must contain value:redis://cache:6379");
|
||||
}
|
||||
|
||||
@Test
|
||||
void redeployRequestWithNullEnv() throws JsonProcessingException {
|
||||
// Verify that a PortainerRedeployRequest with null env serializes without NPE
|
||||
PortainerRedeployRequest request = new PortainerRedeployRequest(false, true, null);
|
||||
String json = mapper.writeValueAsString(request);
|
||||
assertTrue(json.contains("\"PullImage\":false"));
|
||||
assertTrue(json.contains("\"Prune\":true"));
|
||||
// Env may be serialized as null or omitted
|
||||
}
|
||||
|
||||
@Test
|
||||
void redeployRequestRoundTrip() throws JsonProcessingException {
|
||||
// Full round-trip: serialize PortainerRedeployRequest and deserialize back
|
||||
List<EnvVariable> envList = List.of(new EnvVariable("KEY", "VALUE"));
|
||||
PortainerRedeployRequest original = new PortainerRedeployRequest(true, true, envList);
|
||||
String json = mapper.writeValueAsString(original);
|
||||
PortainerRedeployRequest deserialized = mapper.readValue(json, PortainerRedeployRequest.class);
|
||||
|
||||
assertTrue(deserialized.isPullImage());
|
||||
assertTrue(deserialized.isPrune());
|
||||
assertNotNull(deserialized.getEnv());
|
||||
assertEquals(1, deserialized.getEnv().size());
|
||||
assertEquals("KEY", deserialized.getEnv().get(0).getName());
|
||||
assertEquals("VALUE", deserialized.getEnv().get(0).getValue());
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,101 @@
|
||||
package com.hithomelabs.common.portainer.model;
|
||||
|
||||
import com.fasterxml.jackson.core.JsonProcessingException;
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
|
||||
class PortainerStackTest {
|
||||
|
||||
private final ObjectMapper mapper = new ObjectMapper();
|
||||
|
||||
@Test
|
||||
void deserializeWithEnv() throws JsonProcessingException {
|
||||
String json = """
|
||||
{
|
||||
"Id": 1,
|
||||
"Name": "test-stack",
|
||||
"Env": [{"name":"DB_HOST","value":"postgres"}]
|
||||
}
|
||||
""";
|
||||
PortainerStack stack = mapper.readValue(json, PortainerStack.class);
|
||||
assertEquals(1L, stack.getId());
|
||||
assertEquals("test-stack", stack.getName());
|
||||
assertNotNull(stack.getEnv());
|
||||
assertEquals(1, stack.getEnv().size());
|
||||
assertEquals("DB_HOST", stack.getEnv().get(0).getName());
|
||||
assertEquals("postgres", stack.getEnv().get(0).getValue());
|
||||
}
|
||||
|
||||
@Test
|
||||
void deserializeWithResourceControl() throws JsonProcessingException {
|
||||
String json = """
|
||||
{
|
||||
"Id": 1,
|
||||
"ResourceControl": {"Id":1,"Type":2}
|
||||
}
|
||||
""";
|
||||
PortainerStack stack = mapper.readValue(json, PortainerStack.class);
|
||||
assertNotNull(stack.getResourceControl());
|
||||
assertEquals(1, stack.getResourceControl().get("Id"));
|
||||
assertEquals(2, stack.getResourceControl().get("Type"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void deserializeWithNullResourceControl() throws JsonProcessingException {
|
||||
String json = """
|
||||
{
|
||||
"Id": 1,
|
||||
"ResourceControl": null
|
||||
}
|
||||
""";
|
||||
PortainerStack stack = mapper.readValue(json, PortainerStack.class);
|
||||
assertNull(stack.getResourceControl());
|
||||
}
|
||||
|
||||
@Test
|
||||
void deserializeWithoutEnv() throws JsonProcessingException {
|
||||
String json = """
|
||||
{
|
||||
"Id": 1,
|
||||
"Name": "test-stack"
|
||||
}
|
||||
""";
|
||||
PortainerStack stack = mapper.readValue(json, PortainerStack.class);
|
||||
// When no "Env" field is present in JSON, the field should remain null
|
||||
assertNull(stack.getEnv());
|
||||
}
|
||||
|
||||
@Test
|
||||
void deserializeWithMultipleEnvVars() throws JsonProcessingException {
|
||||
String json = """
|
||||
{
|
||||
"Id": 2,
|
||||
"Env": [
|
||||
{"name":"DB_HOST","value":"postgres"},
|
||||
{"name":"DB_PORT","value":"5432"},
|
||||
{"name":"REDIS_URL","value":"redis://cache:6379"}
|
||||
]
|
||||
}
|
||||
""";
|
||||
PortainerStack stack = mapper.readValue(json, PortainerStack.class);
|
||||
assertNotNull(stack.getEnv());
|
||||
assertEquals(3, stack.getEnv().size());
|
||||
assertEquals("DB_PORT", stack.getEnv().get(1).getName());
|
||||
assertEquals("redis://cache:6379", stack.getEnv().get(2).getValue());
|
||||
}
|
||||
|
||||
@Test
|
||||
void deserializeWithEmptyEnv() throws JsonProcessingException {
|
||||
String json = """
|
||||
{
|
||||
"Id": 3,
|
||||
"Env": []
|
||||
}
|
||||
""";
|
||||
PortainerStack stack = mapper.readValue(json, PortainerStack.class);
|
||||
assertNotNull(stack.getEnv());
|
||||
assertTrue(stack.getEnv().isEmpty());
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,107 @@
|
||||
package com.hithomelabs.common.registry.model;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
|
||||
class ImageReferenceTest {
|
||||
|
||||
@Test
|
||||
void parse_withValidImage_returnsImageReference() {
|
||||
ImageReference ref = ImageReference.parse("192.168.0.100:8928/hithomelabs/cftunnels:1.2.3");
|
||||
|
||||
assertNotNull(ref);
|
||||
assertEquals("192.168.0.100:8928", ref.getRegistry());
|
||||
assertEquals("hithomelabs/cftunnels", ref.getRepository());
|
||||
assertEquals("1.2.3", ref.getTag());
|
||||
assertEquals("192.168.0.100:8928/hithomelabs/cftunnels:1.2.3", ref.getFullImage());
|
||||
}
|
||||
|
||||
@Test
|
||||
void parse_withRegistryPortAndMultiLevelRepository_returnsImageReference() {
|
||||
ImageReference ref = ImageReference.parse("registry.example.com:5000/namespace/sub/image:latest");
|
||||
|
||||
assertNotNull(ref);
|
||||
assertEquals("registry.example.com:5000", ref.getRegistry());
|
||||
assertEquals("namespace/sub/image", ref.getRepository());
|
||||
assertEquals("latest", ref.getTag());
|
||||
}
|
||||
|
||||
@Test
|
||||
void parse_withSimpleRegistryPath_returnsImageReference() {
|
||||
ImageReference ref = ImageReference.parse("docker.io/library/nginx:1.25");
|
||||
|
||||
assertNotNull(ref);
|
||||
assertEquals("docker.io", ref.getRegistry());
|
||||
assertEquals("library/nginx", ref.getRepository());
|
||||
assertEquals("1.25", ref.getTag());
|
||||
}
|
||||
|
||||
@Test
|
||||
void parse_withNumericTag_returnsImageReference() {
|
||||
ImageReference ref = ImageReference.parse("myregistry.com/myapp:1");
|
||||
|
||||
assertNotNull(ref);
|
||||
assertEquals("myregistry.com", ref.getRegistry());
|
||||
assertEquals("myapp", ref.getRepository());
|
||||
assertEquals("1", ref.getTag());
|
||||
}
|
||||
|
||||
@Test
|
||||
void parse_withTagContainingHyphenAndDot_returnsImageReference() {
|
||||
ImageReference ref = ImageReference.parse("private.reg.io/team-app:3.2.1-rc1");
|
||||
|
||||
assertNotNull(ref);
|
||||
assertEquals("private.reg.io", ref.getRegistry());
|
||||
assertEquals("team-app", ref.getRepository());
|
||||
assertEquals("3.2.1-rc1", ref.getTag());
|
||||
}
|
||||
|
||||
@Test
|
||||
void parse_withNullImage_throwsIllegalArgumentException() {
|
||||
IllegalArgumentException ex = assertThrows(IllegalArgumentException.class,
|
||||
() -> ImageReference.parse(null));
|
||||
assertTrue(ex.getMessage().contains("null") || ex.getMessage().contains("blank"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void parse_withBlankImage_throwsIllegalArgumentException() {
|
||||
IllegalArgumentException ex = assertThrows(IllegalArgumentException.class,
|
||||
() -> ImageReference.parse(" "));
|
||||
assertTrue(ex.getMessage().contains("null") || ex.getMessage().contains("blank"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void parse_withEmptyImage_throwsIllegalArgumentException() {
|
||||
IllegalArgumentException ex = assertThrows(IllegalArgumentException.class,
|
||||
() -> ImageReference.parse(""));
|
||||
assertTrue(ex.getMessage().contains("null") || ex.getMessage().contains("blank"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void parse_withMissingRegistry_throwsIllegalArgumentException() {
|
||||
IllegalArgumentException ex = assertThrows(IllegalArgumentException.class,
|
||||
() -> ImageReference.parse("nginx:latest"));
|
||||
assertTrue(ex.getMessage().contains("Invalid"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void parse_withMissingTag_throwsIllegalArgumentException() {
|
||||
IllegalArgumentException ex = assertThrows(IllegalArgumentException.class,
|
||||
() -> ImageReference.parse("registry.com/repo"));
|
||||
assertTrue(ex.getMessage().contains("Invalid"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void parse_withMissingColonSeparator_throwsIllegalArgumentException() {
|
||||
IllegalArgumentException ex = assertThrows(IllegalArgumentException.class,
|
||||
() -> ImageReference.parse("registry.com/repo:"));
|
||||
assertTrue(ex.getMessage().contains("Invalid"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void parse_withOnlyRegistry_throwsIllegalArgumentException() {
|
||||
IllegalArgumentException ex = assertThrows(IllegalArgumentException.class,
|
||||
() -> ImageReference.parse("registry.com"));
|
||||
assertTrue(ex.getMessage().contains("Invalid"));
|
||||
}
|
||||
}
|
||||
@ -4,6 +4,7 @@ services:
|
||||
container_name: cftunnels_${ENV}
|
||||
ports:
|
||||
- ${HOST_PORT}:8080
|
||||
- ${MGMT_PORT:-5003}:8081
|
||||
environment:
|
||||
- CLOUDFLARE_ACCOUNT_ID=${CLOUDFLARE_ACCOUNT_ID}
|
||||
- CLOUDFLARE_API_KEY=${CLOUDFLARE_API_KEY}
|
||||
|
||||
2
gradle.properties
Normal file
2
gradle.properties
Normal file
@ -0,0 +1,2 @@
|
||||
version=0.0.1-SNAPSHOT
|
||||
group=com.hithomelabs
|
||||
1
gradle/wrapper/gradle-wrapper.jar.sha256
vendored
Normal file
1
gradle/wrapper/gradle-wrapper.jar.sha256
vendored
Normal file
@ -0,0 +1 @@
|
||||
81a82aaea5abcc8ff68b3dfcb58b3c3c429378efd98e7433460610fecd7ae45f gradle/wrapper/gradle-wrapper.jar
|
||||
41
portainer-automation/.env.example
Normal file
41
portainer-automation/.env.example
Normal file
@ -0,0 +1,41 @@
|
||||
# ============================================
|
||||
# Portainer Automation Service — Environment Variables
|
||||
# ============================================
|
||||
# Copy this file to .env and fill in your values.
|
||||
# This service is NOT exposed via Cloudflare Tunnel (internal-only).
|
||||
|
||||
# --- Portainer Connection ---
|
||||
|
||||
# Portainer API Key for the target Portainer instance
|
||||
# Create via Portainer UI: Settings → Authentication → Access tokens
|
||||
# Dev: https://devdocker.hithomelabs.com → ptk_xxxx_dev_xxxx
|
||||
# Prod: https://192.168.0.100:9443 → ptk_xxxx_prod_xxxx
|
||||
PORTAINER_API_KEY=ptr_your_portainer_api_key_here
|
||||
|
||||
# Portainer endpoint ID (1 = primary Docker endpoint, 2 = remote)
|
||||
PORTAINER_ENDPOINT_ID=2
|
||||
|
||||
# --- Service Auth ---
|
||||
|
||||
# API key that CI workflows send in the X-API-Key header
|
||||
# to authenticate against this service's /api/deploy endpoint
|
||||
PORTAINER_SERVICE_API_KEY=change-me
|
||||
|
||||
# --- Spring Profile ---
|
||||
|
||||
# Active Spring profile (local | ci | prod)
|
||||
# local — uses devdocker.hithomelabs.com via Cloudflare Tunnel (default)
|
||||
# ci — uses test/stub endpoints
|
||||
# prod — uses production Portainer on internal network
|
||||
SPRING_PROFILES_ACTIVE=local
|
||||
|
||||
# --- Deployment ---
|
||||
|
||||
# Deployment environment label (dev | test | prod)
|
||||
ENV=dev
|
||||
|
||||
# Host port to map to container port 8081
|
||||
HOST_PORT=8081
|
||||
|
||||
# Host port to map to actuator management port 8082 (health checks, LAN only)
|
||||
MGMT_PORT=5005
|
||||
13
portainer-automation/Dockerfile
Normal file
13
portainer-automation/Dockerfile
Normal file
@ -0,0 +1,13 @@
|
||||
FROM openjdk:17-jdk as build
|
||||
WORKDIR /app
|
||||
COPY gradlew settings.gradle build.gradle ./
|
||||
COPY gradle ./gradle
|
||||
COPY common ./common
|
||||
COPY cftunnels-service ./cftunnels-service
|
||||
COPY portainer-automation ./portainer-automation
|
||||
RUN ./gradlew :portainer-automation:bootJar
|
||||
|
||||
FROM openjdk:17-jdk-slim
|
||||
COPY --from=build /app/portainer-automation/build/libs/*.jar app.jar
|
||||
EXPOSE 8081 8082
|
||||
ENTRYPOINT ["java", "-jar", "/app.jar"]
|
||||
224
portainer-automation/PORTAINER_STACK.md
Normal file
224
portainer-automation/PORTAINER_STACK.md
Normal file
@ -0,0 +1,224 @@
|
||||
# Portainer Automation Service — Portainer Stack Guide
|
||||
|
||||
## Overview
|
||||
|
||||
The Portainer Automation service exposes a single endpoint (`POST /api/deploy/{stackId}`)
|
||||
that triggers a redeploy of a Portainer stack. CI workflows call this endpoint after
|
||||
pushing new container images.
|
||||
|
||||
The service is deployed as a **separate Portainer stack** (Option B) — independent from
|
||||
the CFTunnels stacks — so it can be reused by other projects.
|
||||
|
||||
---
|
||||
|
||||
## Architecture Diagram
|
||||
|
||||
```
|
||||
┌─────────────────┐ push tag ┌──────────────────┐
|
||||
│ Gitea Runner │ ──────────────► │ Docker Registry │
|
||||
│ (CI workflow) │ │ :8928 │
|
||||
└────────┬────────┘ └──────────────────┘
|
||||
│
|
||||
│ POST /api/deploy/{stackId}
|
||||
│ X-API-Key: <service-api-key>
|
||||
▼
|
||||
┌─────────────────────────────────────┐
|
||||
│ Portainer Automation Service │
|
||||
│ (portainer-automation_${ENV}) │
|
||||
│ port: 8081 │
|
||||
└──────────┬──────────────────────────┘
|
||||
│ PUT /api/stacks/{id}/git/redeploy
|
||||
│ X-API-Key: <portainer-api-key>
|
||||
▼
|
||||
┌─────────────────────────────────────┐
|
||||
│ Portainer CE │
|
||||
│ Dev: :9442 / Prod: :9443 │
|
||||
└──────────┬──────────────────────────┘
|
||||
│ git pull + stack redeploy
|
||||
▼
|
||||
┌─────────────────────────────────────┐
|
||||
│ Target Stack (e.g. CFTunnels) │
|
||||
│ Docker Compose from Git │
|
||||
└─────────────────────────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Portainer Stack Configuration
|
||||
|
||||
### Create a New Stack in Portainer
|
||||
|
||||
1. **Navigate**: Portainer UI → Stacks → **Add stack**
|
||||
2. **Name**: `portainer-automation-{env}` (e.g. `portainer-automation-dev`)
|
||||
3. **Build method**: **Git repository**
|
||||
4. **Repository URL**: `https://gitea.hithomelabs.com/Hithomelabs/CFTunnels.git`
|
||||
5. **Repository reference**: `refs/heads/test` (dev) or `refs/heads/main` (prod)
|
||||
6. **Compose path**: `portainer-automation/docker-compose.yaml`
|
||||
7. **Environment variables**: See table below
|
||||
|
||||
### Environment Variables — Dev
|
||||
|
||||
| Variable | Value | Description |
|
||||
|----------|-------|-------------|
|
||||
| `ENV` | `dev` | Environment label |
|
||||
| `HOST_PORT` | `8081` | Host port mapping |
|
||||
| `SPRING_PROFILES_ACTIVE` | `local` | Spring profile (uses `devdocker.hithomelabs.com`) |
|
||||
| `PORTAINER_API_KEY` | `ptk_xxxx_dev_xxxx` | Portainer Dev API access token |
|
||||
| `PORTAINER_SERVICE_API_KEY` | *(generate a random key)* | CI → Service auth key |
|
||||
|
||||
Portainer Dev endpoint: `https://devdocker.hithomelabs.com` (port 9442 behind Cloudflare Tunnel)
|
||||
|
||||
### Environment Variables — Prod
|
||||
|
||||
| Variable | Value | Description |
|
||||
|----------|-------|-------------|
|
||||
| `ENV` | `prod` | Environment label |
|
||||
| `HOST_PORT` | `8082` | Host port mapping |
|
||||
| `SPRING_PROFILES_ACTIVE` | `prod` | Spring profile (uses `192.168.0.100:9443`) |
|
||||
| `PORTAINER_API_KEY` | `ptk_xxxx_prod_xxxx` | Portainer Prod API access token |
|
||||
| `PORTAINER_SERVICE_API_KEY` | *(generate a different random key)* | CI → Service auth key |
|
||||
|
||||
Portainer Prod endpoint: `https://192.168.0.100:9443` (internal network)
|
||||
|
||||
---
|
||||
|
||||
## Deployment Steps
|
||||
|
||||
### Prerequisites
|
||||
|
||||
1. Portainer Automation Docker image is built and pushed (see CI workflow)
|
||||
2. Portainer API access tokens created (Portainer UI → My access tokens)
|
||||
3. Gitea secrets configured:
|
||||
- `PORTAINER_SERVICE_API_KEY` — shared secret for dev
|
||||
- `PORTAINER_SERVICE_API_KEY_PROD` — shared secret for prod
|
||||
|
||||
### Step 1: Build and Push Image
|
||||
|
||||
The CI workflow `.gitea/workflows/portainer_automation_build_push.yml` handles this
|
||||
automatically on push to the `test` branch.
|
||||
|
||||
To build manually:
|
||||
```bash
|
||||
./gradlew :portainer-automation:bootBuildImage \
|
||||
--imageName=192.168.0.100:8928/hithomelabs/portainer-automation:<version>
|
||||
```
|
||||
|
||||
### Step 2: Create Stack in Portainer (Dev)
|
||||
|
||||
1. Log in to Portainer Dev (`https://devdocker.hithomelabs.com`)
|
||||
2. Stacks → Add stack
|
||||
3. Name: `portainer-automation-dev`
|
||||
4. Build method: Git repository
|
||||
5. Repository: `https://gitea.hithomelabs.com/Hithomelabs/CFTunnels.git`
|
||||
6. Reference: `refs/heads/test`
|
||||
7. Compose path: `portainer-automation/docker-compose.yaml`
|
||||
8. Add env vars from the **Dev** table above
|
||||
9. Click **Deploy the stack**
|
||||
|
||||
### Step 3: Verify Dev Deployment
|
||||
|
||||
```bash
|
||||
# Redeploy a stack via the automation service
|
||||
curl -X POST \
|
||||
-H "X-API-Key: <service-api-key>" \
|
||||
http://portainer-automation-dev:8081/api/deploy/<stack-id>
|
||||
|
||||
# Expected: "Deployment initiated for stack <stack-id>"
|
||||
```
|
||||
|
||||
### Step 4: Create Stack in Portainer (Prod)
|
||||
|
||||
1. Log in to Portainer Prod (`https://192.168.0.100:9443`)
|
||||
2. Follow the same steps as Step 2, with:
|
||||
- Name: `portainer-automation-prod`
|
||||
- Reference: `refs/heads/main`
|
||||
- Env vars from the **Prod** table above
|
||||
|
||||
### Step 5: Wire CI Triggers
|
||||
|
||||
Ensure CI workflows call the automation endpoint:
|
||||
|
||||
**Dev** (in `test_image_build_push.yml`):
|
||||
```yaml
|
||||
- name: Trigger Portainer Redeploy (Dev)
|
||||
if: success()
|
||||
env:
|
||||
PORTAINER_AUTOMATION_URL: "http://portainer-automation-dev:8081"
|
||||
STACK_ID: ${{ vars.PORTAINER_AUTOMATION_DEV_STACK_ID }}
|
||||
API_KEY: ${{ secrets.PORTAINER_SERVICE_API_KEY }}
|
||||
run: |
|
||||
wget -q --no-check-certificate --timeout=30 \
|
||||
--header="X-API-Key: $API_KEY" \
|
||||
-O - \
|
||||
"$PORTAINER_AUTOMATION_URL/api/deploy/$STACK_ID" 2>&1 \
|
||||
|| echo "Deploy trigger failed (non-fatal)"
|
||||
```
|
||||
|
||||
**Prod** (in `prod_image_tag_promote.yaml`):
|
||||
```yaml
|
||||
- name: Trigger Portainer Redeploy (Prod)
|
||||
if: success()
|
||||
env:
|
||||
PORTAINER_AUTOMATION_URL: "http://portainer-automation-prod:8082"
|
||||
STACK_ID: ${{ vars.PORTAINER_AUTOMATION_PROD_STACK_ID }}
|
||||
API_KEY: ${{ secrets.PORTAINER_SERVICE_API_KEY_PROD }}
|
||||
run: |
|
||||
wget -q --no-check-certificate --timeout=30 \
|
||||
--header="X-API-Key: $API_KEY" \
|
||||
-O - \
|
||||
"$PORTAINER_AUTOMATION_URL/api/deploy/$STACK_ID" 2>&1 \
|
||||
|| echo "Deploy trigger failed (non-fatal)"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Configuration Reference
|
||||
|
||||
### Profile Resolution Order
|
||||
|
||||
The service resolves configuration in this order (later overrides earlier):
|
||||
|
||||
1. `application.properties` — default: `https://192.168.0.100:9442`
|
||||
2. `application-{profile}.properties` — profile-specific overrides
|
||||
3. Environment variables — highest priority
|
||||
|
||||
### Profile Purposes
|
||||
|
||||
| Profile | File | Portainer Target | Use Case |
|
||||
|---------|------|-----------------|----------|
|
||||
| default | `application.properties` | `192.168.0.100:9442` (Dev) | CI/CD, Docker compose |
|
||||
| `local` | `application-local.properties` | `devdocker.hithomelabs.com` | Local dev via Cloudflare Tunnel |
|
||||
| `ci` | `application-ci.properties` | `portainer-test:9000` | CI pipeline testing |
|
||||
| `prod` | `application-prod.properties` | `192.168.0.100:9443` (Prod) | Production deployment |
|
||||
|
||||
### Environment Variable Reference
|
||||
|
||||
| Variable | Required | Default | Description |
|
||||
|----------|----------|---------|-------------|
|
||||
| `SPRING_PROFILES_ACTIVE` | No | *(none)* | Active Spring profile |
|
||||
| `PORTAINER_API_KEY` | Yes | — | Portainer API access token |
|
||||
| `PORTAINER_SERVICE_API_KEY` | Yes | — | Shared secret for CI → service auth |
|
||||
| `ENV` | No | `test` | Deployment environment label |
|
||||
| `HOST_PORT` | No | `8081` | External port mapping |
|
||||
|
||||
---
|
||||
|
||||
## Health Checks
|
||||
|
||||
The service exposes no dedicated health endpoint yet. Verify availability by:
|
||||
|
||||
```bash
|
||||
# Check that the service responds (expects 401 Unauthorized without API key)
|
||||
curl -X POST http://portainer-automation-dev:8081/api/deploy/1
|
||||
# Expected: {"timestamp":"...","status":401,"error":"Unauthorized",...}
|
||||
# A 401 response means the service is running.
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
| Symptom | Likely Cause | Fix |
|
||||
|---------|-------------|-----|
|
||||
| `Connection refused` | Service not running | Check stack status in Portainer |
|
||||
| `Invalid API key` | Wrong `PORTAINER_SERVICE_API_KEY` | Verify env var matches CI secret |
|
||||
| `Portainer error: Unauthorized` | Wrong `PORTAINER_API_KEY` | Regenerate token in Portainer UI |
|
||||
| `Stack not found` | Wrong stack ID | Verify stack ID in Portainer URL |
|
||||
16
portainer-automation/build.gradle
Normal file
16
portainer-automation/build.gradle
Normal file
@ -0,0 +1,16 @@
|
||||
apply plugin: 'org.springframework.boot'
|
||||
|
||||
dependencies {
|
||||
implementation project(':common')
|
||||
|
||||
implementation 'org.springframework.boot:spring-boot-starter-web'
|
||||
implementation 'org.springframework.boot:spring-boot-starter-validation'
|
||||
implementation 'org.springframework.boot:spring-boot-starter-actuator'
|
||||
implementation 'org.apache.httpcomponents.client5:httpclient5'
|
||||
|
||||
compileOnly 'org.projectlombok:lombok'
|
||||
annotationProcessor 'org.projectlombok:lombok'
|
||||
annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'
|
||||
|
||||
testImplementation 'org.springframework.boot:spring-boot-starter-test'
|
||||
}
|
||||
14
portainer-automation/docker-compose.yaml
Normal file
14
portainer-automation/docker-compose.yaml
Normal file
@ -0,0 +1,14 @@
|
||||
services:
|
||||
portainer-automation:
|
||||
image: gitea.hithomelabs.com/hithomelabs/portainer-automation:${ENV:-test}
|
||||
container_name: portainer-automation_${ENV:-test}
|
||||
ports:
|
||||
- "${HOST_PORT:-8081}:8081" # Application port (internal service)
|
||||
- "${MGMT_PORT:-5005}:8082" # Health management port (LAN only)
|
||||
environment:
|
||||
- SPRING_PROFILES_ACTIVE=${SPRING_PROFILES_ACTIVE:-local}
|
||||
- PORTAINER_API_KEY=${PORTAINER_API_KEY}
|
||||
- PORTAINER_SERVICE_API_KEY=${PORTAINER_SERVICE_API_KEY}
|
||||
env_file:
|
||||
- ../stack.env
|
||||
restart: unless-stopped
|
||||
@ -0,0 +1,16 @@
|
||||
package com.hithomelabs.portainer;
|
||||
|
||||
import org.springframework.boot.SpringApplication;
|
||||
import org.springframework.boot.autoconfigure.SpringBootApplication;
|
||||
import org.springframework.boot.context.properties.EnableConfigurationProperties;
|
||||
|
||||
import com.hithomelabs.portainer.config.PortainerAutomationProperties;
|
||||
|
||||
@SpringBootApplication(scanBasePackages = {"com.hithomelabs.portainer", "com.hithomelabs.common"})
|
||||
@EnableConfigurationProperties(PortainerAutomationProperties.class)
|
||||
public class PortainerAutomationApplication {
|
||||
|
||||
public static void main(String[] args) {
|
||||
SpringApplication.run(PortainerAutomationApplication.class, args);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,55 @@
|
||||
package com.hithomelabs.portainer.config;
|
||||
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
@ConfigurationProperties(prefix = "portainer")
|
||||
public class PortainerAutomationProperties {
|
||||
private String baseUrl;
|
||||
private String apiKey;
|
||||
private Long endpointId;
|
||||
private Service service = new Service();
|
||||
|
||||
public String getBaseUrl() {
|
||||
return baseUrl;
|
||||
}
|
||||
|
||||
public void setBaseUrl(String baseUrl) {
|
||||
this.baseUrl = baseUrl;
|
||||
}
|
||||
|
||||
public String getApiKey() {
|
||||
return apiKey;
|
||||
}
|
||||
|
||||
public void setApiKey(String apiKey) {
|
||||
this.apiKey = apiKey;
|
||||
}
|
||||
|
||||
public Long getEndpointId() {
|
||||
return endpointId;
|
||||
}
|
||||
|
||||
public void setEndpointId(Long endpointId) {
|
||||
this.endpointId = endpointId;
|
||||
}
|
||||
|
||||
public Service getService() {
|
||||
return service;
|
||||
}
|
||||
|
||||
public void setService(Service service) {
|
||||
this.service = service;
|
||||
}
|
||||
|
||||
public static class Service {
|
||||
private String apiKey;
|
||||
|
||||
public String getApiKey() {
|
||||
return apiKey;
|
||||
}
|
||||
|
||||
public void setApiKey(String apiKey) {
|
||||
this.apiKey = apiKey;
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,85 @@
|
||||
package com.hithomelabs.portainer.config;
|
||||
|
||||
import org.apache.hc.client5.http.impl.classic.HttpClients;
|
||||
import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder;
|
||||
import org.apache.hc.client5.http.io.HttpClientConnectionManager;
|
||||
import org.apache.hc.client5.http.ssl.NoopHostnameVerifier;
|
||||
import org.apache.hc.client5.http.ssl.SSLConnectionSocketFactory;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.context.annotation.Profile;
|
||||
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
|
||||
import org.springframework.web.client.RestTemplate;
|
||||
|
||||
import com.hithomelabs.common.portainer.client.PortainerApiClient;
|
||||
|
||||
import javax.net.ssl.SSLContext;
|
||||
import javax.net.ssl.TrustManager;
|
||||
import javax.net.ssl.X509TrustManager;
|
||||
import java.security.cert.X509Certificate;
|
||||
|
||||
@Configuration
|
||||
public class PortainerClientConfig {
|
||||
|
||||
/**
|
||||
* Builds a RestTemplate that trusts all SSL certificates.
|
||||
* Used when connecting via Cloudflare Tunnel (self-signed certs)
|
||||
* or to the prod Portainer instance (also self-signed).
|
||||
*/
|
||||
private static RestTemplate buildTrustAllRestTemplate() throws Exception {
|
||||
TrustManager[] trustAllCerts = new TrustManager[]{
|
||||
new X509TrustManager() {
|
||||
public X509Certificate[] getAcceptedIssuers() { return new X509Certificate[0]; }
|
||||
public void checkClientTrusted(X509Certificate[] certs, String authType) {}
|
||||
public void checkServerTrusted(X509Certificate[] certs, String authType) {}
|
||||
}
|
||||
};
|
||||
SSLContext sslContext = SSLContext.getInstance("TLS");
|
||||
sslContext.init(null, trustAllCerts, new java.security.SecureRandom());
|
||||
SSLConnectionSocketFactory sslSocketFactory =
|
||||
new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
|
||||
HttpClientConnectionManager cm = PoolingHttpClientConnectionManagerBuilder.create()
|
||||
.setSSLSocketFactory(sslSocketFactory)
|
||||
.build();
|
||||
return new RestTemplate(new HttpComponentsClientHttpRequestFactory(
|
||||
HttpClients.custom().setConnectionManager(cm).build()));
|
||||
}
|
||||
|
||||
/**
|
||||
* Trust-all SSL RestTemplate for the "local" profile.
|
||||
* Used when connecting via Cloudflare Tunnel (self-signed certs).
|
||||
*/
|
||||
@Profile("local")
|
||||
@Bean(name = "portainerRestTemplate")
|
||||
public RestTemplate portainerRestTemplateLocal() throws Exception {
|
||||
return buildTrustAllRestTemplate();
|
||||
}
|
||||
|
||||
/**
|
||||
* Trust-all SSL RestTemplate for the "prod" profile.
|
||||
* Prod Portainer at https://192.168.0.100:9443 uses a self-signed certificate.
|
||||
*/
|
||||
@Profile("prod")
|
||||
@Bean(name = "portainerRestTemplate")
|
||||
public RestTemplate portainerRestTemplateProd() throws Exception {
|
||||
return buildTrustAllRestTemplate();
|
||||
}
|
||||
|
||||
/**
|
||||
* Standard validating SSL RestTemplate for profiles other than local and prod
|
||||
* (CI, test — internal Docker network with valid certs).
|
||||
*/
|
||||
@Profile("!local & !prod")
|
||||
@Bean(name = "portainerRestTemplate")
|
||||
public RestTemplate portainerRestTemplateDefault() {
|
||||
return new RestTemplate();
|
||||
}
|
||||
|
||||
@Bean
|
||||
public PortainerApiClient portainerApiClient(PortainerAutomationProperties props,
|
||||
RestTemplate portainerRestTemplate) {
|
||||
PortainerApiClient client = new PortainerApiClient(portainerRestTemplate, props.getBaseUrl());
|
||||
client.authenticateWithApiKey(props.getApiKey());
|
||||
return client;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,75 @@
|
||||
package com.hithomelabs.portainer.controller;
|
||||
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
import org.springframework.web.bind.annotation.GetMapping;
|
||||
import org.springframework.web.bind.annotation.PathVariable;
|
||||
import org.springframework.web.bind.annotation.PostMapping;
|
||||
import org.springframework.web.bind.annotation.RequestHeader;
|
||||
import org.springframework.web.bind.annotation.RequestMapping;
|
||||
import org.springframework.web.bind.annotation.RestController;
|
||||
|
||||
import com.hithomelabs.common.portainer.client.exception.PortainerAuthenticationException;
|
||||
import com.hithomelabs.common.portainer.client.exception.PortainerConnectionException;
|
||||
import com.hithomelabs.common.portainer.client.exception.PortainerDeploymentException;
|
||||
import com.hithomelabs.common.portainer.client.exception.PortainerResourceNotFoundException;
|
||||
import com.hithomelabs.portainer.config.PortainerAutomationProperties;
|
||||
import com.hithomelabs.portainer.service.DeployService;
|
||||
|
||||
@RestController
|
||||
@RequestMapping("/api")
|
||||
public class DeployController {
|
||||
|
||||
private static final Logger log = LoggerFactory.getLogger(DeployController.class);
|
||||
|
||||
private final DeployService deployService;
|
||||
private final PortainerAutomationProperties props;
|
||||
|
||||
public DeployController(DeployService deployService, PortainerAutomationProperties props) {
|
||||
this.deployService = deployService;
|
||||
this.props = props;
|
||||
}
|
||||
|
||||
@GetMapping("/health")
|
||||
public ResponseEntity<String> health() {
|
||||
return ResponseEntity.ok("{\"status\":\"UP\"}");
|
||||
}
|
||||
|
||||
@PostMapping("/deploy/{stackId}")
|
||||
public ResponseEntity<String> deploy(@PathVariable Long stackId,
|
||||
@RequestHeader(value = "X-API-Key", required = false) String apiKey) {
|
||||
String expectedApiKey = props.getService().getApiKey();
|
||||
if (expectedApiKey == null || !expectedApiKey.equals(apiKey)) {
|
||||
log.warn("Deploy auth failed for stack {}: invalid API key", stackId);
|
||||
return ResponseEntity.status(HttpStatus.UNAUTHORIZED).body("Invalid API key");
|
||||
}
|
||||
log.info("Deployment requested for stack {}", stackId);
|
||||
try {
|
||||
deployService.redeploy(stackId);
|
||||
log.info("Deployment initiated for stack {}", stackId);
|
||||
return ResponseEntity.ok("Deployment initiated for stack " + stackId);
|
||||
} catch (PortainerConnectionException e) {
|
||||
log.error("Portainer connection error for stack {}: {}", stackId, e.getMessage());
|
||||
return ResponseEntity.status(HttpStatus.BAD_GATEWAY)
|
||||
.body("Portainer connection failed: " + e.getMessage());
|
||||
} catch (PortainerResourceNotFoundException e) {
|
||||
log.error("Stack {} not found: {}", stackId, e.getMessage());
|
||||
return ResponseEntity.status(HttpStatus.NOT_FOUND)
|
||||
.body("Stack not found: " + e.getMessage());
|
||||
} catch (PortainerAuthenticationException e) {
|
||||
log.error("Portainer auth error for stack {}: {}", stackId, e.getMessage());
|
||||
return ResponseEntity.status(HttpStatus.UNAUTHORIZED)
|
||||
.body("Portainer authentication failed: " + e.getMessage());
|
||||
} catch (PortainerDeploymentException e) {
|
||||
log.error("Portainer deployment error for stack {}: {}", stackId, e.getMessage());
|
||||
return ResponseEntity.status(HttpStatus.BAD_GATEWAY)
|
||||
.body("Deployment failed: " + e.getMessage());
|
||||
} catch (RuntimeException e) {
|
||||
log.error("Unexpected error deploying stack {}: {}", stackId, e.getMessage(), e);
|
||||
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
|
||||
.body("Deployment failed: " + e.getMessage());
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,46 @@
|
||||
package com.hithomelabs.portainer.service;
|
||||
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.stereotype.Service;
|
||||
|
||||
import com.hithomelabs.common.portainer.client.PortainerApiClient;
|
||||
import com.hithomelabs.common.portainer.client.exception.PortainerConnectionException;
|
||||
import com.hithomelabs.common.portainer.client.exception.PortainerDeploymentException;
|
||||
import com.hithomelabs.common.portainer.client.exception.PortainerResourceNotFoundException;
|
||||
import com.hithomelabs.common.portainer.model.EnvVariable;
|
||||
import com.hithomelabs.common.portainer.model.PortainerStack;
|
||||
import com.hithomelabs.portainer.config.PortainerAutomationProperties;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
@Service
|
||||
public class DeployService {
|
||||
|
||||
private static final Logger log = LoggerFactory.getLogger(DeployService.class);
|
||||
|
||||
private final PortainerApiClient portainerApiClient;
|
||||
private final PortainerAutomationProperties props;
|
||||
|
||||
public DeployService(PortainerApiClient portainerApiClient,
|
||||
PortainerAutomationProperties props) {
|
||||
this.portainerApiClient = portainerApiClient;
|
||||
this.props = props;
|
||||
}
|
||||
|
||||
public void redeploy(Long stackId) {
|
||||
log.info("Redeploying stack {}", stackId);
|
||||
try {
|
||||
PortainerStack stack = portainerApiClient.getStack(stackId);
|
||||
List<EnvVariable> env = stack.getEnv() != null ? stack.getEnv() : List.of();
|
||||
portainerApiClient.redeployGitStack(stackId, props.getEndpointId(), true, env);
|
||||
log.info("Stack {} redeployed successfully", stackId);
|
||||
} catch (PortainerResourceNotFoundException | PortainerConnectionException | PortainerDeploymentException e) {
|
||||
log.error("Deploy failed for stack {}: {}", stackId, e.getMessage());
|
||||
throw e;
|
||||
} catch (RuntimeException e) {
|
||||
log.error("Unexpected error during deploy of stack {}: {}", stackId, e.getMessage(), e);
|
||||
throw e;
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,6 @@
|
||||
# CI-specific Portainer Configuration
|
||||
# Uses test/stub endpoints during CI pipeline testing
|
||||
portainer.base-url=http://portainer-test:9000
|
||||
portainer.api-key=${PORTAINER_API_KEY:ci-test-key}
|
||||
portainer.endpoint-id=1
|
||||
portainer.service.api-key=${PORTAINER_SERVICE_API_KEY:ci-test-key}
|
||||
@ -0,0 +1,4 @@
|
||||
portainer.base-url=https://devdocker.hithomelabs.com
|
||||
portainer.api-key=${PORTAINER_API_KEY:dev-test-key}
|
||||
portainer.endpoint-id=2
|
||||
portainer.service.api-key=dev-test-key
|
||||
@ -0,0 +1,6 @@
|
||||
# Production Portainer Configuration
|
||||
# Targets the production Portainer instance on the internal network (port 9443)
|
||||
portainer.base-url=https://192.168.0.100:9443
|
||||
portainer.api-key=${PORTAINER_API_KEY}
|
||||
portainer.endpoint-id=2
|
||||
portainer.service.api-key=${PORTAINER_SERVICE_API_KEY}
|
||||
@ -0,0 +1,11 @@
|
||||
server.port=8081
|
||||
portainer.base-url=https://192.168.0.100:9442
|
||||
portainer.api-key=${PORTAINER_API_KEY:}
|
||||
portainer.endpoint-id=1
|
||||
portainer.service.api-key=${PORTAINER_SERVICE_API_KEY:change-me}
|
||||
|
||||
# Actuator configuration - management port and exposed endpoints
|
||||
# App runs on server.port=8081, so management port must differ (8082)
|
||||
management.server.port=8082
|
||||
management.endpoints.web.exposure.include=health,info
|
||||
management.endpoint.health.show-details=when-authorized
|
||||
@ -0,0 +1,73 @@
|
||||
package com.hithomelabs.portainer.controller;
|
||||
|
||||
import static org.mockito.ArgumentMatchers.anyLong;
|
||||
import static org.mockito.Mockito.doThrow;
|
||||
import static org.mockito.Mockito.when;
|
||||
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
|
||||
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
|
||||
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
|
||||
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
|
||||
import org.springframework.test.context.bean.override.mockito.MockitoBean;
|
||||
import org.springframework.test.web.servlet.MockMvc;
|
||||
|
||||
import com.hithomelabs.portainer.config.PortainerAutomationProperties;
|
||||
import com.hithomelabs.portainer.service.DeployService;
|
||||
|
||||
@WebMvcTest(DeployController.class)
|
||||
class DeployControllerTest {
|
||||
|
||||
@Autowired
|
||||
private MockMvc mockMvc;
|
||||
|
||||
@MockitoBean
|
||||
private DeployService deployService;
|
||||
|
||||
@MockitoBean
|
||||
private PortainerAutomationProperties props;
|
||||
|
||||
@MockitoBean
|
||||
private PortainerAutomationProperties.Service service;
|
||||
|
||||
@BeforeEach
|
||||
void setUp() {
|
||||
when(props.getService()).thenReturn(service);
|
||||
when(service.getApiKey()).thenReturn("valid-key");
|
||||
}
|
||||
|
||||
@Test
|
||||
void deployWithValidKeyReturnsOk() throws Exception {
|
||||
mockMvc.perform(post("/api/deploy/1")
|
||||
.header("X-API-Key", "valid-key"))
|
||||
.andExpect(status().isOk())
|
||||
.andExpect(content().string("Deployment initiated for stack 1"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void deployWithInvalidKeyReturnsUnauthorized() throws Exception {
|
||||
mockMvc.perform(post("/api/deploy/1")
|
||||
.header("X-API-Key", "wrong-key"))
|
||||
.andExpect(status().isUnauthorized())
|
||||
.andExpect(content().string("Invalid API key"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void deployWithMissingKeyReturnsUnauthorized() throws Exception {
|
||||
mockMvc.perform(post("/api/deploy/1"))
|
||||
.andExpect(status().isUnauthorized())
|
||||
.andExpect(content().string("Invalid API key"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void deployWhenServiceFailsReturnsServerError() throws Exception {
|
||||
doThrow(new RuntimeException("Portainer error"))
|
||||
.when(deployService).redeploy(anyLong());
|
||||
mockMvc.perform(post("/api/deploy/1")
|
||||
.header("X-API-Key", "valid-key"))
|
||||
.andExpect(status().isInternalServerError())
|
||||
.andExpect(content().string("Deployment failed: Portainer error"));
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,97 @@
|
||||
package com.hithomelabs.portainer.service;
|
||||
|
||||
import com.hithomelabs.common.portainer.client.PortainerApiClient;
|
||||
import com.hithomelabs.common.portainer.client.exception.PortainerConnectionException;
|
||||
import com.hithomelabs.common.portainer.client.exception.PortainerResourceNotFoundException;
|
||||
import com.hithomelabs.common.portainer.model.EnvVariable;
|
||||
import com.hithomelabs.common.portainer.model.PortainerStack;
|
||||
import com.hithomelabs.portainer.config.PortainerAutomationProperties;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.junit.jupiter.api.extension.ExtendWith;
|
||||
import org.mockito.Mock;
|
||||
import org.mockito.junit.jupiter.MockitoExtension;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
import static org.mockito.Mockito.*;
|
||||
|
||||
@ExtendWith(MockitoExtension.class)
|
||||
class DeployServiceTest {
|
||||
|
||||
@Mock
|
||||
private PortainerApiClient portainerApiClient;
|
||||
|
||||
@Mock
|
||||
private PortainerAutomationProperties props;
|
||||
|
||||
private DeployService deployService;
|
||||
|
||||
private static final Long STACK_ID = 1L;
|
||||
private static final Long ENDPOINT_ID = 2L;
|
||||
|
||||
@BeforeEach
|
||||
void setUp() {
|
||||
when(props.getEndpointId()).thenReturn(ENDPOINT_ID);
|
||||
deployService = new DeployService(portainerApiClient, props);
|
||||
}
|
||||
|
||||
@Test
|
||||
void redeploy_withEnv_callsRedeployGitStackWithSameEnv() {
|
||||
List<EnvVariable> envList = List.of(new EnvVariable("DB_HOST", "postgres"));
|
||||
PortainerStack stack = new PortainerStack();
|
||||
stack.setEnv(envList);
|
||||
|
||||
when(portainerApiClient.getStack(STACK_ID)).thenReturn(stack);
|
||||
|
||||
deployService.redeploy(STACK_ID);
|
||||
|
||||
verify(portainerApiClient).getStack(STACK_ID);
|
||||
verify(portainerApiClient).redeployGitStack(STACK_ID, ENDPOINT_ID, true, envList);
|
||||
}
|
||||
|
||||
@Test
|
||||
void redeploy_withNullEnv_callsRedeployGitStackWithNull() {
|
||||
PortainerStack stack = new PortainerStack();
|
||||
stack.setEnv(null);
|
||||
|
||||
when(portainerApiClient.getStack(STACK_ID)).thenReturn(stack);
|
||||
|
||||
deployService.redeploy(STACK_ID);
|
||||
|
||||
verify(portainerApiClient).getStack(STACK_ID);
|
||||
// When getEnv() returns null, an empty list is passed to redeployGitStack
|
||||
verify(portainerApiClient).redeployGitStack(STACK_ID, ENDPOINT_ID, true, List.of());
|
||||
}
|
||||
|
||||
@Test
|
||||
void redeploy_whenGetStackThrowsResourceNotFound_propagatesException() {
|
||||
when(portainerApiClient.getStack(STACK_ID))
|
||||
.thenThrow(new PortainerResourceNotFoundException("Stack not found"));
|
||||
|
||||
assertThrows(PortainerResourceNotFoundException.class,
|
||||
() -> deployService.redeploy(STACK_ID));
|
||||
}
|
||||
|
||||
@Test
|
||||
void redeploy_whenGetStackThrowsConnectionError_propagatesException() {
|
||||
when(portainerApiClient.getStack(STACK_ID))
|
||||
.thenThrow(new PortainerConnectionException("Connection refused"));
|
||||
|
||||
assertThrows(PortainerConnectionException.class,
|
||||
() -> deployService.redeploy(STACK_ID));
|
||||
}
|
||||
|
||||
@Test
|
||||
void redeploy_whenRedeployThrows_propagatesException() {
|
||||
PortainerStack stack = new PortainerStack();
|
||||
stack.setEnv(List.of(new EnvVariable("A", "B")));
|
||||
when(portainerApiClient.getStack(STACK_ID)).thenReturn(stack);
|
||||
doThrow(new PortainerConnectionException("Connection refused"))
|
||||
.when(portainerApiClient).redeployGitStack(STACK_ID, ENDPOINT_ID, true, stack.getEnv());
|
||||
|
||||
assertThrows(PortainerConnectionException.class,
|
||||
() -> deployService.redeploy(STACK_ID));
|
||||
}
|
||||
}
|
||||
4
settings.gradle
Normal file
4
settings.gradle
Normal file
@ -0,0 +1,4 @@
|
||||
rootProject.name = 'cftunnels'
|
||||
include 'common'
|
||||
include 'cftunnels-service'
|
||||
include 'portainer-automation'
|
||||
@ -1,13 +0,0 @@
|
||||
package com.hithomelabs.CFTunnels;
|
||||
|
||||
import org.springframework.boot.SpringApplication;
|
||||
import org.springframework.boot.autoconfigure.SpringBootApplication;
|
||||
|
||||
@SpringBootApplication
|
||||
public class CfTunnelsApplication {
|
||||
|
||||
public static void main(String[] args) {
|
||||
SpringApplication.run(CfTunnelsApplication.class, args);
|
||||
}
|
||||
|
||||
}
|
||||
@ -1,22 +0,0 @@
|
||||
package com.hithomelabs.CFTunnels.Config;
|
||||
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
|
||||
@Configuration
|
||||
@ConfigurationProperties(prefix = "cloudflare")
|
||||
public class CloudflareConfig {
|
||||
private String accountId;
|
||||
private String apiKey;
|
||||
private String email;
|
||||
|
||||
// Getters and Setters
|
||||
public String getAccountId() { return accountId; }
|
||||
public void setAccountId(String accountId) { this.accountId = accountId; }
|
||||
|
||||
public String getApiKey() { return apiKey; }
|
||||
public void setApiKey(String apiKey) { this.apiKey = apiKey; }
|
||||
|
||||
public String getEmail() { return email; }
|
||||
public void setEmail(String email) { this.email = email; }
|
||||
}
|
||||
@ -1,22 +0,0 @@
|
||||
package com.hithomelabs.CFTunnels.Config;
|
||||
|
||||
import com.fasterxml.jackson.annotation.JsonInclude;
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import com.fasterxml.jackson.databind.SerializationFeature;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
|
||||
import org.springframework.web.client.RestTemplate;
|
||||
|
||||
@Configuration
|
||||
public class RestTemplateConfig {
|
||||
|
||||
@Bean
|
||||
public RestTemplate restTemplate() {
|
||||
RestTemplate restTemplate = new RestTemplate();
|
||||
MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
|
||||
converter.setObjectMapper(new ObjectMapper().enable(SerializationFeature.WRAP_ROOT_VALUE).setSerializationInclusion(JsonInclude.Include.NON_NULL));
|
||||
restTemplate.getMessageConverters().add(0, converter);
|
||||
return restTemplate;
|
||||
}
|
||||
}
|
||||
@ -1,38 +0,0 @@
|
||||
package com.hithomelabs.CFTunnels.Entity;
|
||||
|
||||
import jakarta.persistence.*;
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Getter;
|
||||
import lombok.NoArgsConstructor;
|
||||
import lombok.Setter;
|
||||
|
||||
|
||||
import java.util.UUID;
|
||||
|
||||
@Entity
|
||||
@Getter
|
||||
@Setter
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
@Table(name = "mappings")
|
||||
public class Mapping {
|
||||
|
||||
@Id
|
||||
@GeneratedValue
|
||||
@Column(columnDefinition = "uuid", nullable = false, unique = true)
|
||||
private UUID id;
|
||||
|
||||
@Column(nullable = false)
|
||||
private int port;
|
||||
|
||||
@Enumerated(EnumType.STRING)
|
||||
@Column(length = 10, nullable = false)
|
||||
private Protocol protocol;
|
||||
|
||||
@Column(length = 50, nullable = false)
|
||||
private String subdomain;
|
||||
|
||||
@ManyToOne(fetch = FetchType.LAZY)
|
||||
@JoinColumn(name = "tunnel_id", nullable = false)
|
||||
private Tunnel tunnel;
|
||||
}
|
||||
@ -1,8 +0,0 @@
|
||||
package com.hithomelabs.CFTunnels.Entity;
|
||||
|
||||
public enum Protocol {
|
||||
HTTP,
|
||||
HTTPS,
|
||||
TCP,
|
||||
SSH
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user