forked from Hithomelabs/CFTunnels
Compare commits
No commits in common. "6fc44a6969645898db9c32814ff35c84651aadee" and "042c7064079c06ab6bafccfb759924472c2d57fe" have entirely different histories.
6fc44a6969
...
042c706407
@ -28,7 +28,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
needs: tag
|
needs: tag
|
||||||
container:
|
container:
|
||||||
image: 192.168.0.100:8928/hithomelabs/ci-runner:1.0.0
|
image: catthehacker/ubuntu:act-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Check out repository code
|
- name: Check out repository code
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
|
|||||||
@ -14,8 +14,7 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
distribution: 'zulu'
|
distribution: 'zulu'
|
||||||
java-version: '17'
|
java-version: '17'
|
||||||
- name: Validate Gradle Wrapper (offline checksum)
|
- name: Validate Gradle Wrapper
|
||||||
run: |
|
uses: gradle/actions/wrapper-validation@v3
|
||||||
sha256sum --check gradle/wrapper/gradle-wrapper.jar.sha256
|
|
||||||
- name: Gradle build
|
- name: Gradle build
|
||||||
run: ./gradlew build --info
|
run: ./gradlew build --info
|
||||||
@ -30,19 +30,19 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
needs: tag
|
needs: tag
|
||||||
container:
|
container:
|
||||||
image: 192.168.0.100:8928/hithomelabs/ci-runner:1.0.0
|
image: catthehacker/ubuntu:act-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Check out repository code
|
- name: Check out repository code
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
- name: Install JDK (Alpine package)
|
- name: JDK setup
|
||||||
run: |
|
uses: actions/setup-java@v4
|
||||||
apk add --no-cache openjdk17-jdk
|
with:
|
||||||
echo "JAVA_HOME=/usr/lib/jvm/java-17-openjdk" >> "$GITHUB_ENV"
|
distribution: 'zulu'
|
||||||
- name: Validate Gradle Wrapper (offline checksum)
|
java-version: '17'
|
||||||
run: |
|
- name: Validate Gradle Wrapper
|
||||||
sha256sum --check gradle/wrapper/gradle-wrapper.jar.sha256
|
uses: gradle/actions/wrapper-validation@v3
|
||||||
- name: Create and push tag
|
- name: Create and push tag
|
||||||
run: |
|
run: |
|
||||||
echo "New version: ${{ needs.tag.outputs.new_version }}"
|
echo "New version: ${{ needs.tag.outputs.new_version }}"
|
||||||
@ -57,10 +57,11 @@ jobs:
|
|||||||
username: hitanshu
|
username: hitanshu
|
||||||
password: ${{ secrets.TOKEN }}
|
password: ${{ secrets.TOKEN }}
|
||||||
- name: Gradle build
|
- name: Gradle build
|
||||||
run: ./gradlew :cftunnels-service:bootBuildImage --imageName=192.168.0.100:8928/hithomelabs/cftunnels:${{ needs.tag.outputs.new_version }}
|
run: ./gradlew bootBuildImage --imageName=192.168.0.100:8928/hithomelabs/cftunnels:${{ needs.tag.outputs.new_version }}
|
||||||
- name: Tag image as test
|
- 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
|
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
|
- name: Push to Gitea Registry
|
||||||
run: |
|
run: |
|
||||||
docker push 192.168.0.100:8928/hithomelabs/cftunnels:test
|
docker push 192.168.0.100:8928/hithomelabs/cftunnels:test
|
||||||
docker push 192.168.0.100:8928/hithomelabs/cftunnels:${{ needs.tag.outputs.new_version }}
|
docker push 192.168.0.100:8928/hithomelabs/cftunnels:${{ needs.tag.outputs.new_version }}
|
||||||
|
|
||||||
|
|||||||
1
.gitignore
vendored
1
.gitignore
vendored
@ -6,7 +6,6 @@ build/
|
|||||||
!gradle/wrapper/gradle-wrapper.jar
|
!gradle/wrapper/gradle-wrapper.jar
|
||||||
!**/src/main/**/build/
|
!**/src/main/**/build/
|
||||||
!**/src/test/**/build/
|
!**/src/test/**/build/
|
||||||
CFTunnels/
|
|
||||||
|
|
||||||
### STS ###
|
### STS ###
|
||||||
.apt_generated
|
.apt_generated
|
||||||
|
|||||||
4
Dockerfile
Normal file
4
Dockerfile
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
FROM openjdk:17-jdk
|
||||||
|
ARG JAR_FILE=target/*.jar
|
||||||
|
COPY ${JAR_FILE} app.jar
|
||||||
|
ENTRYPOINT ["java","-jar","/app.jar"]
|
||||||
186
README.md
186
README.md
@ -1,186 +0,0 @@
|
|||||||
# 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/)
|
|
||||||
53
build.gradle
53
build.gradle
@ -1,13 +1,9 @@
|
|||||||
plugins {
|
plugins {
|
||||||
id 'java'
|
id 'java'
|
||||||
id 'org.springframework.boot' version '3.4.5' apply false
|
id 'org.springframework.boot' version '3.4.5'
|
||||||
id 'io.spring.dependency-management' version '1.1.7' apply false
|
id 'io.spring.dependency-management' version '1.1.7'
|
||||||
}
|
}
|
||||||
|
|
||||||
subprojects {
|
|
||||||
apply plugin: 'java'
|
|
||||||
apply plugin: 'io.spring.dependency-management'
|
|
||||||
|
|
||||||
group = 'com.hithomelabs'
|
group = 'com.hithomelabs'
|
||||||
version = '0.0.1-SNAPSHOT'
|
version = '0.0.1-SNAPSHOT'
|
||||||
|
|
||||||
@ -17,13 +13,50 @@ subprojects {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
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()
|
mavenCentral()
|
||||||
}
|
}
|
||||||
|
|
||||||
dependencyManagement {
|
dependencies {
|
||||||
imports {
|
implementation group: 'org.springdoc', name: 'springdoc-openapi-starter-webmvc-ui', version: '2.8.5'
|
||||||
mavenBom "org.springframework.boot:spring-boot-dependencies:3.4.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()
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,12 +0,0 @@
|
|||||||
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
|
|
||||||
ENTRYPOINT ["java", "-jar", "/app.jar"]
|
|
||||||
@ -1,46 +0,0 @@
|
|||||||
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.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
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,47 +0,0 @@
|
|||||||
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,58 +0,0 @@
|
|||||||
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,86 +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;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 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;
|
|
||||||
}
|
|
||||||
@ -1,43 +0,0 @@
|
|||||||
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
|
|
||||||
}
|
|
||||||
@ -1,120 +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;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 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;
|
|
||||||
}
|
|
||||||
@ -1,67 +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;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 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;
|
|
||||||
}
|
|
||||||
@ -1,68 +0,0 @@
|
|||||||
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,95 +0,0 @@
|
|||||||
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,203 +0,0 @@
|
|||||||
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,13 +0,0 @@
|
|||||||
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'
|
|
||||||
}
|
|
||||||
@ -1,34 +0,0 @@
|
|||||||
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;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,262 +0,0 @@
|
|||||||
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.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);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Redeploy a git-based stack.
|
|
||||||
* Sends a PUT to {@code /api/stacks/{stackId}/git/redeploy?endpointId={endpointId}}.
|
|
||||||
*/
|
|
||||||
public void redeployGitStack(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, false);
|
|
||||||
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());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,12 +0,0 @@
|
|||||||
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);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,12 +0,0 @@
|
|||||||
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);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,12 +0,0 @@
|
|||||||
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);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,12 +0,0 @@
|
|||||||
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);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,35 +0,0 @@
|
|||||||
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;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
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;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,35 +0,0 @@
|
|||||||
package com.hithomelabs.common.portainer.model;
|
|
||||||
|
|
||||||
import com.fasterxml.jackson.annotation.JsonProperty;
|
|
||||||
|
|
||||||
public class PortainerRedeployRequest {
|
|
||||||
|
|
||||||
@JsonProperty("PullImage")
|
|
||||||
private boolean pullImage;
|
|
||||||
|
|
||||||
@JsonProperty("Prune")
|
|
||||||
private boolean prune;
|
|
||||||
|
|
||||||
public PortainerRedeployRequest() {}
|
|
||||||
|
|
||||||
public PortainerRedeployRequest(boolean pullImage, boolean prune) {
|
|
||||||
this.pullImage = pullImage;
|
|
||||||
this.prune = prune;
|
|
||||||
}
|
|
||||||
|
|
||||||
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;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,63 +0,0 @@
|
|||||||
package com.hithomelabs.common.portainer.model;
|
|
||||||
|
|
||||||
import com.fasterxml.jackson.annotation.JsonProperty;
|
|
||||||
|
|
||||||
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 String resourceControl;
|
|
||||||
|
|
||||||
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 String getResourceControl() {
|
|
||||||
return resourceControl;
|
|
||||||
}
|
|
||||||
|
|
||||||
public void setResourceControl(String resourceControl) {
|
|
||||||
this.resourceControl = resourceControl;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,65 +0,0 @@
|
|||||||
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;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,223 +0,0 @@
|
|||||||
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.model.PortainerAuthRequest;
|
|
||||||
import com.hithomelabs.common.portainer.model.PortainerAuthResponse;
|
|
||||||
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 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 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"));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,107 +0,0 @@
|
|||||||
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"));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,2 +0,0 @@
|
|||||||
version=0.0.1-SNAPSHOT
|
|
||||||
group=com.hithomelabs
|
|
||||||
1
gradle/wrapper/gradle-wrapper.jar.sha256
vendored
1
gradle/wrapper/gradle-wrapper.jar.sha256
vendored
@ -1 +0,0 @@
|
|||||||
81a82aaea5abcc8ff68b3dfcb58b3c3c429378efd98e7433460610fecd7ae45f gradle/wrapper/gradle-wrapper.jar
|
|
||||||
@ -1,14 +0,0 @@
|
|||||||
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'
|
|
||||||
|
|
||||||
compileOnly 'org.projectlombok:lombok'
|
|
||||||
annotationProcessor 'org.projectlombok:lombok'
|
|
||||||
annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'
|
|
||||||
|
|
||||||
testImplementation 'org.springframework.boot:spring-boot-starter-test'
|
|
||||||
}
|
|
||||||
@ -1,12 +0,0 @@
|
|||||||
package com.hithomelabs.portainer;
|
|
||||||
|
|
||||||
import org.springframework.boot.SpringApplication;
|
|
||||||
import org.springframework.boot.autoconfigure.SpringBootApplication;
|
|
||||||
|
|
||||||
@SpringBootApplication
|
|
||||||
public class PortainerAutomationApplication {
|
|
||||||
|
|
||||||
public static void main(String[] args) {
|
|
||||||
SpringApplication.run(PortainerAutomationApplication.class, args);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1 +0,0 @@
|
|||||||
server.port=8081
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
rootProject.name = 'cftunnels'
|
|
||||||
include 'common'
|
|
||||||
include 'cftunnels-service'
|
|
||||||
include 'portainer-automation'
|
|
||||||
@ -0,0 +1,13 @@
|
|||||||
|
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,7 +1,7 @@
|
|||||||
package com.hithomelabs.cftunnels.Config;
|
package com.hithomelabs.CFTunnels.Config;
|
||||||
|
|
||||||
import com.hithomelabs.cftunnels.Models.Authorities;
|
import com.hithomelabs.CFTunnels.Models.Authorities;
|
||||||
import com.hithomelabs.cftunnels.Models.Groups;
|
import com.hithomelabs.CFTunnels.Models.Groups;
|
||||||
import org.springframework.context.annotation.Configuration;
|
import org.springframework.context.annotation.Configuration;
|
||||||
import org.springframework.security.core.GrantedAuthority;
|
import org.springframework.security.core.GrantedAuthority;
|
||||||
import org.springframework.security.core.authority.SimpleGrantedAuthority;
|
import org.springframework.security.core.authority.SimpleGrantedAuthority;
|
||||||
@ -0,0 +1,22 @@
|
|||||||
|
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,4 +1,4 @@
|
|||||||
package com.hithomelabs.cftunnels.Config;
|
package com.hithomelabs.CFTunnels.Config;
|
||||||
|
|
||||||
import org.springframework.beans.factory.annotation.Autowired;
|
import org.springframework.beans.factory.annotation.Autowired;
|
||||||
import org.springframework.context.annotation.Configuration;
|
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.Components;
|
||||||
import io.swagger.v3.oas.models.OpenAPI;
|
import io.swagger.v3.oas.models.OpenAPI;
|
||||||
@ -0,0 +1,22 @@
|
|||||||
|
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,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.beans.factory.annotation.Autowired;
|
||||||
import org.springframework.context.annotation.Bean;
|
import org.springframework.context.annotation.Bean;
|
||||||
import org.springframework.context.annotation.Configuration;
|
import org.springframework.context.annotation.Configuration;
|
||||||
@ -1,20 +1,20 @@
|
|||||||
package com.hithomelabs.cftunnels.Controllers;
|
package com.hithomelabs.CFTunnels.Controllers;
|
||||||
|
|
||||||
import com.fasterxml.jackson.core.JsonProcessingException;
|
import com.fasterxml.jackson.core.JsonProcessingException;
|
||||||
import com.hithomelabs.cftunnels.Config.AuthoritiesToGroupMapping;
|
import com.hithomelabs.CFTunnels.Config.AuthoritiesToGroupMapping;
|
||||||
import com.hithomelabs.cftunnels.Config.CloudflareConfig;
|
import com.hithomelabs.CFTunnels.Config.CloudflareConfig;
|
||||||
import com.hithomelabs.common.config.RestTemplateConfig;
|
import com.hithomelabs.CFTunnels.Config.RestTemplateConfig;
|
||||||
import com.hithomelabs.cftunnels.Entity.Request;
|
import com.hithomelabs.CFTunnels.Entity.Request;
|
||||||
import com.hithomelabs.cftunnels.Entity.Tunnel;
|
import com.hithomelabs.CFTunnels.Entity.Tunnel;
|
||||||
import com.hithomelabs.cftunnels.Entity.User;
|
import com.hithomelabs.CFTunnels.Entity.User;
|
||||||
import com.hithomelabs.cftunnels.Headers.AuthKeyEmailHeader;
|
import com.hithomelabs.CFTunnels.Headers.AuthKeyEmailHeader;
|
||||||
import com.hithomelabs.cftunnels.Models.Config;
|
import com.hithomelabs.CFTunnels.Models.Config;
|
||||||
import com.hithomelabs.cftunnels.Models.Ingress;
|
import com.hithomelabs.CFTunnels.Models.Ingress;
|
||||||
import com.hithomelabs.cftunnels.Models.TunnelResponse;
|
import com.hithomelabs.CFTunnels.Models.TunnelResponse;
|
||||||
import com.hithomelabs.cftunnels.Models.TunnelsResponse;
|
import com.hithomelabs.CFTunnels.Models.TunnelsResponse;
|
||||||
import com.hithomelabs.cftunnels.Repositories.UserRepository;
|
import com.hithomelabs.CFTunnels.Repositories.UserRepository;
|
||||||
import com.hithomelabs.cftunnels.Services.CloudflareAPIService;
|
import com.hithomelabs.CFTunnels.Services.CloudflareAPIService;
|
||||||
import com.hithomelabs.cftunnels.Services.MappingRequestService;
|
import com.hithomelabs.CFTunnels.Services.MappingRequestService;
|
||||||
import io.swagger.v3.oas.annotations.Operation;
|
import io.swagger.v3.oas.annotations.Operation;
|
||||||
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
|
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
|
||||||
import org.springframework.beans.factory.annotation.Autowired;
|
import org.springframework.beans.factory.annotation.Autowired;
|
||||||
@ -22,6 +22,7 @@ import org.springframework.beans.factory.annotation.Value;
|
|||||||
import org.springframework.boot.web.servlet.error.ErrorController;
|
import org.springframework.boot.web.servlet.error.ErrorController;
|
||||||
import org.springframework.dao.DataAccessException;
|
import org.springframework.dao.DataAccessException;
|
||||||
import org.springframework.http.*;
|
import org.springframework.http.*;
|
||||||
|
import org.springframework.http.*;
|
||||||
import org.springframework.security.access.prepost.PreAuthorize;
|
import org.springframework.security.access.prepost.PreAuthorize;
|
||||||
import org.springframework.security.core.GrantedAuthority;
|
import org.springframework.security.core.GrantedAuthority;
|
||||||
import org.springframework.security.core.annotation.AuthenticationPrincipal;
|
import org.springframework.security.core.annotation.AuthenticationPrincipal;
|
||||||
@ -35,41 +36,6 @@ import java.util.Map;
|
|||||||
import java.util.NoSuchElementException;
|
import java.util.NoSuchElementException;
|
||||||
import java.util.UUID;
|
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
|
@RestController
|
||||||
@RequestMapping("/cloudflare")
|
@RequestMapping("/cloudflare")
|
||||||
public class TunnelController implements ErrorController {
|
public class TunnelController implements ErrorController {
|
||||||
@ -97,21 +63,9 @@ public class TunnelController implements ErrorController {
|
|||||||
@Autowired
|
@Autowired
|
||||||
private UserRepository userRepository;
|
private UserRepository userRepository;
|
||||||
|
|
||||||
/**
|
|
||||||
* Current environment (loaded from spring.profiles.active).
|
|
||||||
*/
|
|
||||||
@Value("${spring.profiles.active}")
|
@Value("${spring.profiles.active}")
|
||||||
private String environment;
|
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')")
|
@PreAuthorize("hasAnyRole('USER')")
|
||||||
@GetMapping("/whoami")
|
@GetMapping("/whoami")
|
||||||
public Map<String,Object> whoAmI(@AuthenticationPrincipal OidcUser oidcUser) {
|
public Map<String,Object> whoAmI(@AuthenticationPrincipal OidcUser oidcUser) {
|
||||||
@ -125,16 +79,6 @@ 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')")
|
@PreAuthorize("hasAnyRole('USER')")
|
||||||
@GetMapping("/tunnels")
|
@GetMapping("/tunnels")
|
||||||
@Operation( security = { @SecurityRequirement(name = "oidcAuth") } )
|
@Operation( security = { @SecurityRequirement(name = "oidcAuth") } )
|
||||||
@ -148,16 +92,6 @@ public class TunnelController implements ErrorController {
|
|||||||
return ResponseEntity.ok(jsonResponse);
|
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')")
|
@PreAuthorize("hasAnyRole('USER')")
|
||||||
@GetMapping("/configured/tunnels")
|
@GetMapping("/configured/tunnels")
|
||||||
public ResponseEntity<Map<String,Object>> getConfiguredTunnels(){
|
public ResponseEntity<Map<String,Object>> getConfiguredTunnels(){
|
||||||
@ -172,14 +106,6 @@ 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')")
|
@PreAuthorize("hasAnyRole('USER')")
|
||||||
@GetMapping("/requests")
|
@GetMapping("/requests")
|
||||||
public ResponseEntity<Map<String,Object>> getAllRequests() {
|
public ResponseEntity<Map<String,Object>> getAllRequests() {
|
||||||
@ -194,17 +120,6 @@ 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')")
|
@PreAuthorize("hasAnyRole('DEVELOPER')")
|
||||||
@GetMapping("/tunnels/{tunnelId}/mappings")
|
@GetMapping("/tunnels/{tunnelId}/mappings")
|
||||||
public ResponseEntity<Map<String,Object>> getTunnelConfigurations(@PathVariable String tunnelId) {
|
public ResponseEntity<Map<String,Object>> getTunnelConfigurations(@PathVariable String tunnelId) {
|
||||||
@ -217,41 +132,22 @@ public class TunnelController implements ErrorController {
|
|||||||
return ResponseEntity.ok(jsonResponse);
|
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')")
|
@PreAuthorize("hasAnyRole('ADMIN')")
|
||||||
@PostMapping("/tunnels/{tunnelId}/mappings")
|
@PostMapping("/tunnels/{tunnelId}/mappings")
|
||||||
public ResponseEntity<Map<String, Object>> addTunnelconfiguration(@PathVariable String tunnelId, @RequestBody Ingress ingress) throws JsonProcessingException {
|
public ResponseEntity<Map<String, Object>> addTunnelconfiguration(@PathVariable String tunnelId, @RequestBody Ingress ingress) throws JsonProcessingException {
|
||||||
|
|
||||||
ResponseEntity<TunnelResponse> responseEntity = cloudflareAPIService.getCloudflareTunnelConfigurations(tunnelId, restTemplateConfig.restTemplate(), TunnelResponse.class);
|
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();
|
Config config = responseEntity.getBody().getResult().getConfig();
|
||||||
List<Ingress> response_ingress = config.getIngress();
|
List<Ingress> response_ingress = config.getIngress();
|
||||||
response_ingress.add(response_ingress.size()-1, ingress);
|
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);
|
ResponseEntity<TunnelResponse> response = cloudflareAPIService.putCloudflareTunnelConfigurations(tunnelId, restTemplateConfig.restTemplate(), TunnelResponse.class, config);
|
||||||
|
|
||||||
// Displaying response
|
// * * Displaying response
|
||||||
Map<String, Object> jsonResponse = new HashMap<>();
|
Map<String, Object> jsonResponse = new HashMap<>();
|
||||||
jsonResponse.put("status", response.getStatusCode().toString());
|
jsonResponse.put("status", response.getStatusCode().toString());
|
||||||
jsonResponse.put("data", response.getBody());
|
jsonResponse.put("data", response.getBody());
|
||||||
@ -259,32 +155,21 @@ public class TunnelController implements ErrorController {
|
|||||||
return ResponseEntity.ok(jsonResponse);
|
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')")
|
@PreAuthorize("hasAnyRole('DEVELOPER')")
|
||||||
@DeleteMapping("/tunnels/{tunnelId}/mappings")
|
@DeleteMapping("/tunnels/{tunnelId}/mappings")
|
||||||
public ResponseEntity<Map<String, Object>> deleteTunnelConfiguration(@PathVariable String tunnelId, @RequestBody Ingress ingress) throws JsonProcessingException {
|
public ResponseEntity<Map<String, Object>> deleteTunnelConfiguration(@PathVariable String tunnelId, @RequestBody Ingress ingress) throws JsonProcessingException {
|
||||||
|
|
||||||
ResponseEntity<TunnelResponse> responseEntity = cloudflareAPIService.getCloudflareTunnelConfigurations(tunnelId, restTemplateConfig.restTemplate(), TunnelResponse.class);
|
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();
|
Config config = responseEntity.getBody().getResult().getConfig();
|
||||||
List<Ingress> response_ingress = config.getIngress();
|
List<Ingress> response_ingress = config.getIngress();
|
||||||
Boolean result = Ingress.deleteByHostName(response_ingress, ingress.getHostname());
|
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);
|
ResponseEntity<TunnelResponse> response = cloudflareAPIService.putCloudflareTunnelConfigurations(tunnelId, restTemplateConfig.restTemplate(), TunnelResponse.class, config);
|
||||||
|
|
||||||
// Displaying response
|
// * * Displaying response
|
||||||
Map<String, Object> jsonResponse = new HashMap<>();
|
Map<String, Object> jsonResponse = new HashMap<>();
|
||||||
|
|
||||||
if (result){
|
if (result){
|
||||||
@ -299,20 +184,6 @@ public class TunnelController implements ErrorController {
|
|||||||
return ResponseEntity.ok(jsonResponse);
|
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')")
|
@PreAuthorize("hasAnyRole('DEVELOPER')")
|
||||||
@PostMapping("/tunnels/configure/{tunnelId}/requests")
|
@PostMapping("/tunnels/configure/{tunnelId}/requests")
|
||||||
public ResponseEntity<Request> createTunnelMappingRequest(@PathVariable String tunnelId, @AuthenticationPrincipal OidcUser oidcUser, @RequestBody Ingress ingess){
|
public ResponseEntity<Request> createTunnelMappingRequest(@PathVariable String tunnelId, @AuthenticationPrincipal OidcUser oidcUser, @RequestBody Ingress ingess){
|
||||||
@ -322,17 +193,6 @@ public class TunnelController implements ErrorController {
|
|||||||
return ResponseEntity.status(HttpStatus.BAD_REQUEST).build();
|
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')")
|
@PreAuthorize("hasAnyRole('APPROVER')")
|
||||||
@PutMapping("/requests/{requestId}/approve")
|
@PutMapping("/requests/{requestId}/approve")
|
||||||
public ResponseEntity<Request> approveMappingRequest(@PathVariable UUID requestId, @AuthenticationPrincipal OidcUser oidcUser) {
|
public ResponseEntity<Request> approveMappingRequest(@PathVariable UUID requestId, @AuthenticationPrincipal OidcUser oidcUser) {
|
||||||
@ -350,17 +210,6 @@ 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')")
|
@PreAuthorize("hasAnyRole('APPROVER')")
|
||||||
@PutMapping("/requests/{requestId}/reject")
|
@PutMapping("/requests/{requestId}/reject")
|
||||||
public ResponseEntity<Request> rejectMappingRequest(@PathVariable UUID requestId, @AuthenticationPrincipal OidcUser oidcUser) {
|
public ResponseEntity<Request> rejectMappingRequest(@PathVariable UUID requestId, @AuthenticationPrincipal OidcUser oidcUser) {
|
||||||
@ -378,31 +227,13 @@ 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')")
|
@PreAuthorize("hasAnyRole('ADMIN')")
|
||||||
@PutMapping("/tunnels/configure/{tunnelId}")
|
@PutMapping("/tunnels/configure/{tunnelId}")
|
||||||
public ResponseEntity<Tunnel> configureTunnelForEnvironment(@PathVariable String tunnelId, @AuthenticationPrincipal OidcUser user) {
|
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 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 204 if the object state did not need any changing.
|
||||||
* Returns 404 if the tunnelId is not valid
|
* * Returns 404 if the tunnelId is not valid
|
||||||
*/
|
*/
|
||||||
|
|
||||||
try {
|
try {
|
||||||
38
src/main/java/com/hithomelabs/CFTunnels/Entity/Mapping.java
Normal file
38
src/main/java/com/hithomelabs/CFTunnels/Entity/Mapping.java
Normal file
@ -0,0 +1,38 @@
|
|||||||
|
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;
|
||||||
|
}
|
||||||
@ -0,0 +1,8 @@
|
|||||||
|
package com.hithomelabs.CFTunnels.Entity;
|
||||||
|
|
||||||
|
public enum Protocol {
|
||||||
|
HTTP,
|
||||||
|
HTTPS,
|
||||||
|
TCP,
|
||||||
|
SSH
|
||||||
|
}
|
||||||
45
src/main/java/com/hithomelabs/CFTunnels/Entity/Request.java
Normal file
45
src/main/java/com/hithomelabs/CFTunnels/Entity/Request.java
Normal file
@ -0,0 +1,45 @@
|
|||||||
|
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 = "requests")
|
||||||
|
public class Request {
|
||||||
|
|
||||||
|
@Id
|
||||||
|
@GeneratedValue
|
||||||
|
@Column(columnDefinition = "uuid", unique = true, nullable = false)
|
||||||
|
private UUID id;
|
||||||
|
|
||||||
|
@OneToOne
|
||||||
|
@JoinColumn(name = "mapping_id", unique = true, nullable = false)
|
||||||
|
private Mapping mapping;
|
||||||
|
|
||||||
|
@ManyToOne
|
||||||
|
@JoinColumn(name = "created_by", nullable = false)
|
||||||
|
private User createdBy;
|
||||||
|
|
||||||
|
@ManyToOne
|
||||||
|
@JoinColumn(name = "accepted_by")
|
||||||
|
private User acceptedBy;
|
||||||
|
|
||||||
|
public enum RequestStatus {
|
||||||
|
PENDING,
|
||||||
|
APPROVED,
|
||||||
|
REJECTED
|
||||||
|
}
|
||||||
|
|
||||||
|
@Enumerated(EnumType.STRING)
|
||||||
|
@Column(length = 10, nullable = false)
|
||||||
|
private RequestStatus status;
|
||||||
|
}
|
||||||
28
src/main/java/com/hithomelabs/CFTunnels/Entity/Tunnel.java
Normal file
28
src/main/java/com/hithomelabs/CFTunnels/Entity/Tunnel.java
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
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="tunnels")
|
||||||
|
public class Tunnel {
|
||||||
|
|
||||||
|
@Id
|
||||||
|
@Column(columnDefinition = "uuid", insertable = false, updatable = false, nullable = false)
|
||||||
|
private UUID id;
|
||||||
|
|
||||||
|
@Column(length = 10, unique = true, nullable = false)
|
||||||
|
private String environment;
|
||||||
|
|
||||||
|
@Column(length = 50, unique = true, nullable = false)
|
||||||
|
private String name;
|
||||||
|
}
|
||||||
30
src/main/java/com/hithomelabs/CFTunnels/Entity/User.java
Normal file
30
src/main/java/com/hithomelabs/CFTunnels/Entity/User.java
Normal file
@ -0,0 +1,30 @@
|
|||||||
|
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;
|
||||||
|
|
||||||
|
@Entity
|
||||||
|
@Getter
|
||||||
|
@Setter
|
||||||
|
@NoArgsConstructor
|
||||||
|
@AllArgsConstructor
|
||||||
|
@Table(name = "users")
|
||||||
|
public class User {
|
||||||
|
@Id
|
||||||
|
@GeneratedValue
|
||||||
|
@Column(columnDefinition = "uuid", insertable = false, updatable = false, nullable = false)
|
||||||
|
private UUID id;
|
||||||
|
|
||||||
|
@Column(length = 50, nullable = false)
|
||||||
|
@Size(max = 50)
|
||||||
|
private String name;
|
||||||
|
|
||||||
|
@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 class ExternalServiceException extends RuntimeException {
|
||||||
public ExternalServiceException(String message) { super(message); }
|
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.beans.factory.annotation.Autowired;
|
||||||
import org.springframework.http.HttpHeaders;
|
import org.springframework.http.HttpHeaders;
|
||||||
import org.springframework.stereotype.Component;
|
import org.springframework.stereotype.Component;
|
||||||
@ -1,4 +1,4 @@
|
|||||||
package com.hithomelabs.cftunnels.Models;
|
package com.hithomelabs.CFTunnels.Models;
|
||||||
|
|
||||||
public class Authorities {
|
public class Authorities {
|
||||||
|
|
||||||
@ -1,4 +1,4 @@
|
|||||||
package com.hithomelabs.cftunnels.Models;
|
package com.hithomelabs.CFTunnels.Models;
|
||||||
|
|
||||||
import com.fasterxml.jackson.annotation.*;
|
import com.fasterxml.jackson.annotation.*;
|
||||||
|
|
||||||
@ -1,4 +1,4 @@
|
|||||||
package com.hithomelabs.cftunnels.Models;
|
package com.hithomelabs.CFTunnels.Models;
|
||||||
|
|
||||||
public class Groups {
|
public class Groups {
|
||||||
|
|
||||||
26
src/main/java/com/hithomelabs/CFTunnels/Models/Ingress.java
Normal file
26
src/main/java/com/hithomelabs/CFTunnels/Models/Ingress.java
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
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;
|
||||||
|
|
||||||
|
@NoArgsConstructor
|
||||||
|
@AllArgsConstructor
|
||||||
|
@Getter
|
||||||
|
@Setter
|
||||||
|
public class Ingress {
|
||||||
|
|
||||||
|
private String service;
|
||||||
|
private String hostname;
|
||||||
|
private Map<String, Object> originRequest;
|
||||||
|
private String path;
|
||||||
|
|
||||||
|
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;
|
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.AllArgsConstructor;
|
||||||
import lombok.Getter;
|
import lombok.Getter;
|
||||||
@ -1,4 +1,4 @@
|
|||||||
package com.hithomelabs.cftunnels.Models;
|
package com.hithomelabs.CFTunnels.Models;
|
||||||
|
|
||||||
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
|
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
|
||||||
import lombok.AllArgsConstructor;
|
import lombok.AllArgsConstructor;
|
||||||
@ -1,4 +1,4 @@
|
|||||||
package com.hithomelabs.cftunnels.Models;
|
package com.hithomelabs.CFTunnels.Models;
|
||||||
|
|
||||||
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
|
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
|
||||||
import lombok.AllArgsConstructor;
|
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.data.jpa.repository.JpaRepository;
|
||||||
import org.springframework.stereotype.Repository;
|
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.Page;
|
||||||
import org.springframework.data.domain.Pageable;
|
import org.springframework.data.domain.Pageable;
|
||||||
import org.springframework.data.jpa.repository.JpaRepository;
|
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.data.jpa.repository.JpaRepository;
|
||||||
import org.springframework.stereotype.Repository;
|
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.data.jpa.repository.JpaRepository;
|
||||||
import org.springframework.stereotype.Repository;
|
import org.springframework.stereotype.Repository;
|
||||||
|
|
||||||
@ -0,0 +1,108 @@
|
|||||||
|
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
|
||||||
|
public class CloudflareAPIService {
|
||||||
|
|
||||||
|
@Autowired
|
||||||
|
CloudflareConfig cloudflareConfig;
|
||||||
|
|
||||||
|
@Autowired
|
||||||
|
AuthKeyEmailHeader authKeyEmailHeader;
|
||||||
|
|
||||||
|
@Autowired
|
||||||
|
RestTemplate restTemplate;
|
||||||
|
|
||||||
|
@Autowired
|
||||||
|
TunnelRepository tunnelRepository;
|
||||||
|
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
|
||||||
|
private Tunnel getTunnelFromTunnelResponse(TunnelResult tunnelResult, String env){
|
||||||
|
return new Tunnel(UUID.fromString(tunnelResult.getId()), env, tunnelResult.getName());
|
||||||
|
}
|
||||||
|
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
|
||||||
|
public List<Tunnel> getAllConfiguredTunnels() {
|
||||||
|
return tunnelRepository.findAll();
|
||||||
|
}
|
||||||
|
|
||||||
|
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.Mapping;
|
||||||
import com.hithomelabs.cftunnels.Entity.Protocol;
|
import com.hithomelabs.CFTunnels.Entity.Protocol;
|
||||||
import com.hithomelabs.cftunnels.Entity.Request;
|
import com.hithomelabs.CFTunnels.Entity.Request;
|
||||||
import com.hithomelabs.cftunnels.Entity.Tunnel;
|
import com.hithomelabs.CFTunnels.Entity.Tunnel;
|
||||||
import com.hithomelabs.cftunnels.Entity.User;
|
import com.hithomelabs.CFTunnels.Entity.User;
|
||||||
import com.hithomelabs.cftunnels.Models.Ingress;
|
import com.hithomelabs.CFTunnels.Models.Ingress;
|
||||||
import com.hithomelabs.cftunnels.Repositories.MappingRepository;
|
import com.hithomelabs.CFTunnels.Repositories.MappingRepository;
|
||||||
import com.hithomelabs.cftunnels.Repositories.RequestRepository;
|
import com.hithomelabs.CFTunnels.Repositories.RequestRepository;
|
||||||
import com.hithomelabs.cftunnels.Repositories.TunnelRepository;
|
import com.hithomelabs.CFTunnels.Repositories.TunnelRepository;
|
||||||
import com.hithomelabs.cftunnels.Repositories.UserRepository;
|
import com.hithomelabs.CFTunnels.Repositories.UserRepository;
|
||||||
import org.springframework.beans.factory.annotation.Autowired;
|
import org.springframework.beans.factory.annotation.Autowired;
|
||||||
import org.springframework.http.ResponseEntity;
|
import org.springframework.http.ResponseEntity;
|
||||||
import org.springframework.security.oauth2.core.oidc.user.OidcUser;
|
import org.springframework.security.oauth2.core.oidc.user.OidcUser;
|
||||||
@ -2,9 +2,9 @@ spring.application.name=CFTunnels
|
|||||||
cloudflare.accountId=${CLOUDFLARE_ACCOUNT_ID}
|
cloudflare.accountId=${CLOUDFLARE_ACCOUNT_ID}
|
||||||
cloudflare.apiKey=${CLOUDFLARE_API_KEY}
|
cloudflare.apiKey=${CLOUDFLARE_API_KEY}
|
||||||
cloudflare.email=${CLOUDFLARE_EMAIL}
|
cloudflare.email=${CLOUDFLARE_EMAIL}
|
||||||
spring.profiles.active=${ENV:default}
|
spring.profiles.active=${ENV}
|
||||||
|
|
||||||
# Making sure app works behind a reverse proxy
|
/ * * Masking sure app works behind a reverse proxy
|
||||||
server.forward-headers-strategy=framework
|
server.forward-headers-strategy=framework
|
||||||
|
|
||||||
spring.security.oauth2.client.registration.cftunnels.client-id=${OAUTH_CLIENT_ID}
|
spring.security.oauth2.client.registration.cftunnels.client-id=${OAUTH_CLIENT_ID}
|
||||||
@ -1,4 +1,4 @@
|
|||||||
package com.hithomelabs.cftunnels;
|
package com.hithomelabs.CFTunnels;
|
||||||
|
|
||||||
import org.junit.jupiter.api.Test;
|
import org.junit.jupiter.api.Test;
|
||||||
import org.springframework.boot.test.context.SpringBootTest;
|
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.fasterxml.jackson.databind.ObjectMapper;
|
||||||
import com.hithomelabs.cftunnels.Config.AuthoritiesToGroupMapping;
|
import com.hithomelabs.CFTunnels.Config.AuthoritiesToGroupMapping;
|
||||||
import com.hithomelabs.cftunnels.Config.CloudflareConfig;
|
import com.hithomelabs.CFTunnels.Config.CloudflareConfig;
|
||||||
import com.hithomelabs.common.config.RestTemplateConfig;
|
import com.hithomelabs.CFTunnels.Config.RestTemplateConfig;
|
||||||
import com.hithomelabs.cftunnels.Headers.AuthKeyEmailHeader;
|
import com.hithomelabs.CFTunnels.Headers.AuthKeyEmailHeader;
|
||||||
import com.hithomelabs.cftunnels.Entity.Request;
|
import com.hithomelabs.CFTunnels.Entity.Request;
|
||||||
import com.hithomelabs.cftunnels.Entity.Tunnel;
|
import com.hithomelabs.CFTunnels.Entity.Tunnel;
|
||||||
import com.hithomelabs.cftunnels.Models.Authorities;
|
import com.hithomelabs.CFTunnels.Models.Authorities;
|
||||||
import com.hithomelabs.cftunnels.Models.Config;
|
import com.hithomelabs.CFTunnels.Models.Config;
|
||||||
import com.hithomelabs.cftunnels.Models.Groups;
|
import com.hithomelabs.CFTunnels.Models.Groups;
|
||||||
import com.hithomelabs.cftunnels.Models.TunnelResponse;
|
import com.hithomelabs.CFTunnels.Models.TunnelResponse;
|
||||||
import com.hithomelabs.cftunnels.Models.TunnelResult;
|
import com.hithomelabs.CFTunnels.Models.TunnelResult;
|
||||||
import com.hithomelabs.cftunnels.Models.TunnelsResponse;
|
import com.hithomelabs.CFTunnels.Models.TunnelsResponse;
|
||||||
import com.hithomelabs.cftunnels.Repositories.UserRepository;
|
import com.hithomelabs.CFTunnels.Repositories.UserRepository;
|
||||||
import com.hithomelabs.cftunnels.Services.CloudflareAPIService;
|
import com.hithomelabs.CFTunnels.Services.CloudflareAPIService;
|
||||||
import com.hithomelabs.cftunnels.Services.MappingRequestService;
|
import com.hithomelabs.CFTunnels.Services.MappingRequestService;
|
||||||
import org.junit.jupiter.api.DisplayName;
|
import org.junit.jupiter.api.DisplayName;
|
||||||
import org.junit.jupiter.api.Test;
|
import org.junit.jupiter.api.Test;
|
||||||
import org.springframework.beans.factory.annotation.Autowired;
|
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.PageImpl;
|
||||||
import org.springframework.data.domain.PageRequest;
|
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.hamcrest.core.IsIterableContaining.hasItem;
|
||||||
import static org.mockito.ArgumentMatchers.any;
|
import static org.mockito.ArgumentMatchers.any;
|
||||||
import static org.mockito.ArgumentMatchers.eq;
|
import static org.mockito.ArgumentMatchers.eq;
|
||||||
@ -207,9 +207,9 @@ class TunnelControllerTest {
|
|||||||
@Test
|
@Test
|
||||||
@DisplayName("should return list of requests")
|
@DisplayName("should return list of requests")
|
||||||
void getAllRequests_Success() throws Exception {
|
void getAllRequests_Success() throws Exception {
|
||||||
List<com.hithomelabs.cftunnels.Entity.Request> requests = Arrays.asList(
|
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.PENDING),
|
||||||
createTestRequest(UUID.randomUUID(), com.hithomelabs.cftunnels.Entity.Request.RequestStatus.APPROVED)
|
createTestRequest(UUID.randomUUID(), com.hithomelabs.CFTunnels.Entity.Request.RequestStatus.APPROVED)
|
||||||
);
|
);
|
||||||
|
|
||||||
when(mappingRequestService.getAllRequests()).thenReturn(requests);
|
when(mappingRequestService.getAllRequests()).thenReturn(requests);
|
||||||
@ -227,11 +227,11 @@ class TunnelControllerTest {
|
|||||||
@DisplayName("should create mapping request successfully")
|
@DisplayName("should create mapping request successfully")
|
||||||
void createTunnelMappingRequest_Success() throws Exception {
|
void createTunnelMappingRequest_Success() throws Exception {
|
||||||
UUID tunnelId = UUID.randomUUID();
|
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.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())
|
mockMvc.perform(post("/cloudflare/tunnels/configure/{tunnelId}/requests", tunnelId.toString())
|
||||||
.with(oauth2Login().oauth2User(buildOidcUser("developer", Groups.HOMELAB_DEVELOPER)))
|
.with(oauth2Login().oauth2User(buildOidcUser("developer", Groups.HOMELAB_DEVELOPER)))
|
||||||
@ -247,15 +247,15 @@ class TunnelControllerTest {
|
|||||||
@DisplayName("should approve mapping request successfully")
|
@DisplayName("should approve mapping request successfully")
|
||||||
void approveMappingRequest_Success() throws Exception {
|
void approveMappingRequest_Success() throws Exception {
|
||||||
UUID requestId = UUID.randomUUID();
|
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.setEmail("approver@example.com");
|
||||||
approverUser.setName("Approver");
|
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.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);
|
.thenReturn(approvedRequest);
|
||||||
when(userRepository.findByEmail("approver@example.com"))
|
when(userRepository.findByEmail("approver@example.com"))
|
||||||
.thenReturn(java.util.Optional.of(approverUser));
|
.thenReturn(java.util.Optional.of(approverUser));
|
||||||
@ -272,11 +272,11 @@ class TunnelControllerTest {
|
|||||||
@DisplayName("should return 404 when request not found")
|
@DisplayName("should return 404 when request not found")
|
||||||
void approveMappingRequest_NotFound() throws Exception {
|
void approveMappingRequest_NotFound() throws Exception {
|
||||||
UUID requestId = UUID.randomUUID();
|
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.setEmail("approver@example.com");
|
||||||
approverUser.setName("Approver");
|
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"));
|
.thenThrow(new NoSuchElementException("Request not found"));
|
||||||
when(userRepository.findByEmail("approver@example.com"))
|
when(userRepository.findByEmail("approver@example.com"))
|
||||||
.thenReturn(java.util.Optional.of(approverUser));
|
.thenReturn(java.util.Optional.of(approverUser));
|
||||||
@ -291,11 +291,11 @@ class TunnelControllerTest {
|
|||||||
@DisplayName("should return 500 when mapping creation fails")
|
@DisplayName("should return 500 when mapping creation fails")
|
||||||
void approveMappingRequest_InternalServerError() throws Exception {
|
void approveMappingRequest_InternalServerError() throws Exception {
|
||||||
UUID requestId = UUID.randomUUID();
|
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.setEmail("approver@example.com");
|
||||||
approverUser.setName("Approver");
|
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"));
|
.thenThrow(new RuntimeException("Failed to add mapping to Cloudflare"));
|
||||||
when(userRepository.findByEmail("approver@example.com"))
|
when(userRepository.findByEmail("approver@example.com"))
|
||||||
.thenReturn(java.util.Optional.of(approverUser));
|
.thenReturn(java.util.Optional.of(approverUser));
|
||||||
@ -310,15 +310,15 @@ class TunnelControllerTest {
|
|||||||
@DisplayName("should reject mapping request successfully")
|
@DisplayName("should reject mapping request successfully")
|
||||||
void rejectMappingRequest_Success() throws Exception {
|
void rejectMappingRequest_Success() throws Exception {
|
||||||
UUID requestId = UUID.randomUUID();
|
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.setEmail("rejecter@example.com");
|
||||||
rejecterUser.setName("Rejecter");
|
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.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);
|
.thenReturn(rejectedRequest);
|
||||||
when(userRepository.findByEmail("rejecter@example.com"))
|
when(userRepository.findByEmail("rejecter@example.com"))
|
||||||
.thenReturn(java.util.Optional.of(rejecterUser));
|
.thenReturn(java.util.Optional.of(rejecterUser));
|
||||||
@ -335,11 +335,11 @@ class TunnelControllerTest {
|
|||||||
@DisplayName("should return 404 when rejecting non-existent request")
|
@DisplayName("should return 404 when rejecting non-existent request")
|
||||||
void rejectMappingRequest_NotFound() throws Exception {
|
void rejectMappingRequest_NotFound() throws Exception {
|
||||||
UUID requestId = UUID.randomUUID();
|
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.setEmail("rejecter@example.com");
|
||||||
rejecterUser.setName("Rejecter");
|
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"));
|
.thenThrow(new NoSuchElementException("Request not found"));
|
||||||
when(userRepository.findByEmail("rejecter@example.com"))
|
when(userRepository.findByEmail("rejecter@example.com"))
|
||||||
.thenReturn(java.util.Optional.of(rejecterUser));
|
.thenReturn(java.util.Optional.of(rejecterUser));
|
||||||
@ -354,11 +354,11 @@ class TunnelControllerTest {
|
|||||||
@DisplayName("should return 409 when rejecting already processed request")
|
@DisplayName("should return 409 when rejecting already processed request")
|
||||||
void rejectMappingRequest_Conflict() throws Exception {
|
void rejectMappingRequest_Conflict() throws Exception {
|
||||||
UUID requestId = UUID.randomUUID();
|
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.setEmail("rejecter@example.com");
|
||||||
rejecterUser.setName("Rejecter");
|
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"));
|
.thenThrow(new IllegalStateException("Request is not in PENDING status"));
|
||||||
when(userRepository.findByEmail("rejecter@example.com"))
|
when(userRepository.findByEmail("rejecter@example.com"))
|
||||||
.thenReturn(java.util.Optional.of(rejecterUser));
|
.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.Config.CloudflareConfig;
|
||||||
import com.hithomelabs.cftunnels.Headers.AuthKeyEmailHeader;
|
import com.hithomelabs.CFTunnels.Headers.AuthKeyEmailHeader;
|
||||||
import com.hithomelabs.cftunnels.Models.Config;
|
import com.hithomelabs.CFTunnels.Models.Config;
|
||||||
import com.hithomelabs.cftunnels.Models.Ingress;
|
import com.hithomelabs.CFTunnels.Models.Ingress;
|
||||||
import com.hithomelabs.cftunnels.Models.TunnelResponse;
|
import com.hithomelabs.CFTunnels.Models.TunnelResponse;
|
||||||
import com.hithomelabs.cftunnels.Models.TunnelResult;
|
import com.hithomelabs.CFTunnels.Models.TunnelResult;
|
||||||
import com.hithomelabs.cftunnels.Models.TunnelsResponse;
|
import com.hithomelabs.CFTunnels.Models.TunnelsResponse;
|
||||||
import com.hithomelabs.cftunnels.Services.CloudflareAPIService;
|
import com.hithomelabs.CFTunnels.Services.CloudflareAPIService;
|
||||||
import org.junit.jupiter.api.DisplayName;
|
import org.junit.jupiter.api.DisplayName;
|
||||||
import org.junit.jupiter.api.Tag;
|
import org.junit.jupiter.api.Tag;
|
||||||
import org.junit.jupiter.api.Test;
|
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.Mapping;
|
||||||
import com.hithomelabs.cftunnels.Entity.Protocol;
|
import com.hithomelabs.CFTunnels.Entity.Protocol;
|
||||||
import com.hithomelabs.cftunnels.Entity.Request;
|
import com.hithomelabs.CFTunnels.Entity.Request;
|
||||||
import com.hithomelabs.cftunnels.Entity.Tunnel;
|
import com.hithomelabs.CFTunnels.Entity.Tunnel;
|
||||||
import com.hithomelabs.cftunnels.Entity.User;
|
import com.hithomelabs.CFTunnels.Entity.User;
|
||||||
import org.junit.jupiter.api.BeforeEach;
|
import org.junit.jupiter.api.BeforeEach;
|
||||||
import org.junit.jupiter.api.DisplayName;
|
import org.junit.jupiter.api.DisplayName;
|
||||||
import org.junit.jupiter.api.Test;
|
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.core.JsonProcessingException;
|
||||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||||
import com.hithomelabs.cftunnels.Config.CloudflareConfig;
|
import com.hithomelabs.CFTunnels.Config.CloudflareConfig;
|
||||||
import com.hithomelabs.cftunnels.Entity.Tunnel;
|
import com.hithomelabs.CFTunnels.Entity.Tunnel;
|
||||||
import com.hithomelabs.cftunnels.Exceptions.ExternalServiceException;
|
import com.hithomelabs.CFTunnels.Exceptions.ExternalServiceException;
|
||||||
import com.hithomelabs.cftunnels.Headers.AuthKeyEmailHeader;
|
import com.hithomelabs.CFTunnels.Headers.AuthKeyEmailHeader;
|
||||||
import com.hithomelabs.cftunnels.Models.Config;
|
import com.hithomelabs.CFTunnels.Models.Config;
|
||||||
import com.hithomelabs.cftunnels.Models.Ingress;
|
import com.hithomelabs.CFTunnels.Models.Ingress;
|
||||||
import com.hithomelabs.cftunnels.Models.TunnelResponse;
|
import com.hithomelabs.CFTunnels.Models.TunnelResponse;
|
||||||
import com.hithomelabs.cftunnels.Models.TunnelResult;
|
import com.hithomelabs.CFTunnels.Models.TunnelResult;
|
||||||
import com.hithomelabs.cftunnels.Models.TunnelsResponse;
|
import com.hithomelabs.CFTunnels.Models.TunnelsResponse;
|
||||||
import com.hithomelabs.cftunnels.Repositories.TunnelRepository;
|
import com.hithomelabs.CFTunnels.Repositories.TunnelRepository;
|
||||||
import org.junit.jupiter.api.Test;
|
import org.junit.jupiter.api.Test;
|
||||||
import org.junit.jupiter.api.extension.ExtendWith;
|
import org.junit.jupiter.api.extension.ExtendWith;
|
||||||
import org.mockito.InjectMocks;
|
import org.mockito.InjectMocks;
|
||||||
@ -26,7 +26,7 @@ import java.util.NoSuchElementException;
|
|||||||
import java.util.Optional;
|
import java.util.Optional;
|
||||||
import java.util.UUID;
|
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.assertEquals;
|
||||||
import static org.junit.jupiter.api.Assertions.assertThrows;
|
import static org.junit.jupiter.api.Assertions.assertThrows;
|
||||||
import static org.mockito.ArgumentMatchers.any;
|
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;
|
import org.springframework.core.io.ClassPathResource;
|
||||||
|
|
||||||
Loading…
Reference in New Issue
Block a user