Skip to content

RUNNING.md

Latest commit

 

History

History
380 lines (256 loc) · 7.89 KB

RUNNING.md

File metadata and controls

380 lines (256 loc) · 7.89 KB

Running EDS

EDS can be deployed using multiple runtime options. All require a PostgreSQL database.

Prerequisites

Java

EDS requires Java 21 or later.

PostgreSQL Database Setup

Use the provided SQL scripts to set up the database:

# Run as postgres user (recommended)
sudo -u postgres psql --file accessories/release/postgresql/01-setup.sql

# Or if postgres has a Linux password
su postgres
psql postgres --file accessories/release/postgresql/01-setup.sql
exit

The 01-setup.sql script automatically runs:

  • 02-init.sql - Creates database and user
  • 03-create.sql - Creates tables
  • 04-update-*.sql - Applies any schema updates

Option 1: WildFly Standalone Server

Deploy the WAR file to an existing WildFly installation using the provided control script.

Build

mvn clean package -pl eds-wildfly -am -DskipTests

Setup Environment

export JBOSS_HOME="/path/to/wildfly"
export PATH="${PATH}:$(pwd)/accessories/release/bin"

Using the Control Script

cd accessories

# Start WildFly
wildfly.sh start

# Configure WildFly (downloads PostgreSQL driver, creates datasource)
wildfly.sh configure

# Deploy EDS
wildfly.sh deploy

# Check status
wildfly.sh status

# View logs
wildfly.sh log

# Undeploy
wildfly.sh undeploy

# Stop WildFly
wildfly.sh stop

Debug Mode

Start WildFly with remote debugging enabled:

export DEBUG_PORT=8787
wildfly.sh start

Script Configuration

Edit accessories/release/bin/wildfly.sh to customize:

Variable Default Description
dbHost localhost Database host
dbPort 5432 Database port
dbUser eds_user Database user
dbPassword eds Database password
dbName eds Database name
maxPostSize 26214400 Max upload size (25 MB)

Option 2: WildFly Bootable JAR (Galleon)

Self-contained executable JAR with embedded WildFly server.

Build

mvn clean package -pl eds-wildfly -am -DskipTests

Run with Defaults

java -jar eds-wildfly/target/eds-runnable.jar

Run with Custom Properties

Create a properties file (e.g., eds.properties):

# Database
eds.db.url=jdbc:postgresql://dbserver:5432/eds
eds.db.user=eds_user
eds.db.password=secret

# Server ports
jboss.http.port=8080
jboss.management.http.port=9990

Run with properties file:

java -jar eds-wildfly/target/eds-runnable.jar --properties=eds.properties

Or pass properties directly:

java -Deds.db.url=jdbc:postgresql://dbserver:5432/eds \
     -Deds.db.user=eds_user \
     -Deds.db.password=secret \
     -jar eds-wildfly/target/eds-runnable.jar

Bootable JAR Properties

Property Default Description
eds.db.url jdbc:postgresql://localhost:5432/eds Database JDBC URL
eds.db.user eds_user Database user
eds.db.password eds Database password
jboss.http.port 8080 HTTP port
jboss.management.http.port 9990 Management port

Option 3: Quarkus

Lightweight runtime using Quarkus framework.

Build

mvn clean package -pl eds-quarkus -am -DskipTests

Run with Defaults

java -jar eds-quarkus/target/eds-runnable.jar

Run with Custom Properties

Pass properties via system properties:

java -Dquarkus.datasource.jdbc.url=jdbc:postgresql://dbserver:5432/eds \
     -Dquarkus.datasource.username=eds_user \
     -Dquarkus.datasource.password=secret \
     -Dquarkus.http.port=8080 \
     -jar eds-quarkus/target/eds-runnable.jar

Or use an external config file:

java -Dquarkus.config.locations=/path/to/application.properties \
     -jar eds-quarkus/target/eds-runnable.jar

Quarkus Properties

Property Default Description
quarkus.http.port 8080 HTTP port
quarkus.http.root-path /eds Application context path
quarkus.datasource.jdbc.url jdbc:postgresql://localhost:5432/eds Database URL
quarkus.datasource.username eds_user Database user
quarkus.datasource.password eds Database password

Option 4: Spring Boot

Lightweight runtime using Spring Boot framework.

Build

mvn clean package -pl eds-spring -am -DskipTests

Run with Defaults

java -jar eds-spring/target/eds-runnable.jar

Run with Custom Properties

Pass properties via system properties:

java -Dspring.datasource.url=jdbc:postgresql://dbserver:5432/eds \
     -Dspring.datasource.username=eds_user \
     -Dspring.datasource.password=secret \
     -Dserver.port=8080 \
     -jar eds-spring/target/eds-runnable.jar

Or use an external config file:

java -Dspring.config.location=/path/to/application.properties \
     -jar eds-spring/target/eds-runnable.jar

Spring Boot Properties

Property Default Description
server.port 8080 HTTP port
server.servlet.context-path /eds Application context path
spring.datasource.url jdbc:postgresql://localhost:5432/eds Database URL
spring.datasource.username eds_user Database user
spring.datasource.password eds Database password

Option 5: Docker Compose

Run EDS using Docker Compose with separate PostgreSQL and Quarkus containers.

Prerequisites

  • Docker and Docker Compose installed

Build and Run

cd accessories

# Build Quarkus JAR and start containers
./docker.sh build

Docker Control Script

cd accessories

# Start existing containers
./docker.sh start

# Stop containers
./docker.sh stop

# Restart containers
./docker.sh restart

# Reset database (removes all data)
./docker.sh reset

# View logs
./docker.sh logs

# Show container status
./docker.sh status

# Enter application container shell
./docker.sh interactive

# Remove containers and images
./docker.sh remove

Architecture

The Docker Compose setup creates:

Service Description
eds-db PostgreSQL 16 database
eds-app Quarkus application container

Both containers communicate over an internal eds-network bridge network.

Custom Configuration

Override settings using environment variables in docker-compose.yml or via command line:

# Custom port mapping
docker compose up -d -e QUARKUS_HTTP_PORT=9080

# Or edit docker-compose.yml ports section

Data Persistence

Data is stored in local bind mounts under accessories/docker/volumes/:

Path Description
volumes/data/ PostgreSQL database files
volumes/logs/ Application logs (eds.log)

To reset the database:

./docker.sh reset

Verifying the Installation

After starting, verify EDS is running:

curl http://localhost:8080/eds/api/version

FitNesse Integration Testing

EDS includes FitNesse-based integration tests that provide both testing and documentation.

Prerequisites

Download FitNesse standalone JAR from http://fitnesse.org/ and place it in the eds-fitnesse directory (or create a symlink).

Build Test Fixtures

mvn clean package -pl eds-fitnesse -am -DskipTests

Start FitNesse

The fitnesse binary can be found at https://fitnesse.org/.

cd eds-fitnesse
java -jar fitnesse-standalone.jar -p 2080

Access the test suite at: http://localhost:2080/EDS

Running Tests

  • Tests can be run as a complete suite or individually
  • Each test is independent and self-contained
  • By default, tests run against http://localhost:8080/eds

Configuration

The target EDS instance and request type (REST) can be configured in the setup section of the tests within FitNesse.

Shutdown FitNesse

curl http://localhost:2080/?shutdown

Or visit http://localhost:2080/?shutdown in a browser.

API Documentation

The REST API is documented in:

  • accessories/release/openapi.json - OpenAPI 3.0 specification