6 |
7 | # SchemaCrawler Web Application
8 |
9 | > **Note**: Please see the [SchemaCrawler website](https://www.schemacrawler.com/) for more details.
10 |
11 |
12 | ## Technologies
13 |
14 | This is a Spring Boot web application with a Bootstrap user interface, with source code control in GitHub, which is automatically built on every commit by GitHub Actions using a Maven build, tests are run, and coverage measured with JaCoCo and Codecov.io, and then immediately deployed to Heroku using a Docker image, which generates an crows-foot ERD of a SQLite database.
15 |
16 |
17 | ## Build and Run
18 |
19 | ### Build
20 |
21 | - Install [Graphviz](https://www.graphviz.org), which is a prerequisite for SchemaCrawler
22 | - Install Docker
23 | - Build application from Maven, run `mvn clean package`
24 |
25 |
26 | ### Build Docker Image
27 |
28 | - Follow the steps above
29 | - Install Docker
30 | - Build application and Docker image from Maven, run `mvn -Ddocker.skip=false clean package`
31 |
32 |
33 | ### Start the Server
34 |
35 | - Set the following environmental variables locally
36 | - AWS_ACCESS_KEY_ID
37 | - AWS_SECRET_ACCESS_KEY
38 | - AWS_S3_BUCKET
39 | - Do one of the steps below to start the web application locally on your system
40 | - Start the application from Maven, run
41 | `mvn -Dspring-boot.run.fork=false spring-boot:run`
42 | - Start application from the jar file, run
43 | `java -jar target/schemacrawler-webapp-16.26.1-1.jar`
44 | - Start the application from the local image in a Docker container, run
45 | `docker run -d --rm --env AWS_ACCESS_KEY_ID=xxxxx --env AWS_SECRET_ACCESS_KEY=xxxxx --env AWS_S3_BUCKET=xxxxx -p 8080:8080 -t schemacrawler/schemacrawler-webapp`
46 |
47 |
48 | ### Use the Application
49 |
50 | Then, after you ensure that the web server is running, either from the command-line,
51 | or the Docker container, open a browser to
52 | [https://localhost:8080](https://localhost:8080)
53 |
--------------------------------------------------------------------------------
/.github/copilot-instructions.md:
--------------------------------------------------------------------------------
1 | # Instructions for Java Projects Using Apache Maven
## General Coding Guidelines
- Prefer **immutability** and use the `final` keyword for fields, parameters, and local variables when appropriate.
- Follow **Java 21 best practices**, including usage of `Optional`, `Streams`, and functional programming where applicable.
- Ensure **thread safety** by avoiding mutable shared state and using synchronized wrappers or concurrency utilities when necessary.
- Use **meaningful names** for classes, methods, and variables to improve code readability.
- Follow **SOLID principles** to enhance maintainability and scalability.
- Write meaningful **javadocs** for functions and classes.
## Project Structure
- Organize packages based on functionality (e.g., `service`, `repository`, `controller`).
- Use **Apache Maven** for build management and dependency resolution.
- Maintain a **consistent project structure**, following standard conventions.
## Dependencies and Versions
- Define **explicit versions** for dependencies to prevent compatibility issues.
- Prefer **dependency management** using `dependencyManagement` in `pom.xml` for centralized version control.
- Use **dependency exclusions** where necessary to avoid unwanted transitive dependencies.
## Testing and Quality
- Write **unit tests** for business logic using JUnit 5 with Hamcrest matchers.
- Use **Mockito** for mocking dependencies in tests.
- Maintain **high test coverage** to ensure reliability.
--------------------------------------------------------------------------------
/.github/dependabot.yml:
--------------------------------------------------------------------------------
1 | version: 2
2 | updates:
3 | - package-ecosystem: maven
4 | directory: "/"
5 | schedule:
6 | interval: "weekly"
7 | - package-ecosystem: "github-actions"
8 | directory: "/"
9 | schedule:
10 | interval: "weekly"
11 |
--------------------------------------------------------------------------------
/.github/workflows/integration-tests.yml:
--------------------------------------------------------------------------------
1 | name: Integration Tests
2 |
3 | on:
4 | workflow_dispatch:
5 | push:
6 | schedule:
7 | - cron: '12 0/11 * * *'
8 |
9 | concurrency:
10 | group: ${{ github.workflow }}-${{ github.ref }}
11 | cancel-in-progress: true
12 |
13 | jobs:
14 | build:
15 | name: Integration Tests
16 | runs-on: ubuntu-latest
17 | steps:
18 |
19 | # SETUP BUILD ENVIRONMENT
20 | - id: prepare-maven-build
21 | name: Prepare Maven build
22 | uses: sualeh/prepare-maven-build@v1.4.0
23 | with:
24 | java-version: 21
25 | - id: install-graphviz
26 | name: Install Graphviz
27 | uses: sualeh/install-graphviz@v1.0.3
28 | - id: setup-node
29 | name: Set up Node.js
30 | uses: actions/setup-node@v4
31 | with:
32 | node-version: '20.x'
33 | - id: install-newman
34 | name: Install newman
35 | shell: bash
36 | run: |
37 | # Install newman
38 | npm install -g newman
39 | newman -v
40 |
41 | # BUILD DEPENDENCIES
42 | - id: checkout-schemacrawler
43 | name: Checkout SchemaCrawler
44 | uses: actions/checkout@v4
45 | with:
46 | repository: schemacrawler/SchemaCrawler
47 | path: SchemaCrawler
48 | - id: build-schemacrawler
49 | name: Build SchemaCrawler for local Maven repository
50 | shell: bash
51 | run: |
52 | # Build SchemaCrawler
53 | cd SchemaCrawler
54 | mvn \
55 | --no-transfer-progress \
56 | --batch-mode \
57 | -DskipTests=true \
58 | clean install
59 |
60 | # BUILD AND TEST
61 | - id: build-test
62 | name: Build and run tests
63 | shell: bash
64 | run: |
65 | # Build
66 | mvn \
67 | --no-transfer-progress \
68 | --batch-mode \
69 | package
70 |
71 | # RUN INTEGRATION TESTS WITH NEWMAN
72 | - id: run-postman
73 | name: Run Postman tests for API
74 | env:
75 | AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
76 | AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
77 | AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
78 | shell: bash
79 | run: |
80 | # Build
81 | timeout 120s mvn spring-boot:run > application.log 2>&1 &
82 | sleep 15
83 | newman run \
84 | --verbose \
85 | --color on \
86 | --delay-request 1000 \
87 | --working-dir src/test/postman \
88 | --env-var "url=http://localhost:8080" \
89 | src/test/postman/schemacrawler-web-application.postman_collection.json
90 | - id: upload-application-log
91 | name: Upload application log
92 | uses: actions/upload-artifact@v4
93 | if: always()
94 | with:
95 | name: application-log
96 | path: ./application.log
97 | retention-days: 5
98 |
--------------------------------------------------------------------------------
/.github/workflows/quick-build.yml:
--------------------------------------------------------------------------------
1 | name: Quick Build
2 |
3 | on:
4 | workflow_dispatch:
5 | push:
6 | pull_request:
7 | branches:
8 | - main
9 |
10 | concurrency:
11 | group: ${{ github.workflow }}-${{ github.ref }}
12 | cancel-in-progress: true
13 |
14 | permissions: read-all
15 |
16 | jobs:
17 | build:
18 | name: Quick build
19 | runs-on: ubuntu-latest
20 |
21 | # Service containers to run with workflow
22 | services:
23 | swagger-editor:
24 | image: swaggerapi/swagger-editor
25 | ports:
26 | - 80:8080
27 |
28 |
29 | steps:
30 |
31 | # SETUP BUILD ENVIRONMENT
32 | - id: prepare-maven-build
33 | name: Prepare Maven build
34 | uses: sualeh/prepare-maven-build@v1.4.0
35 | with:
36 | java-version: 21
37 | - id: install-graphviz
38 | name: Install Graphviz
39 | uses: sualeh/install-graphviz@v1.0.3
40 |
41 | # BUILD DEPENDENCIES
42 | - id: checkout-schemacrawler
43 | name: Checkout SchemaCrawler
44 | uses: actions/checkout@v4
45 | with:
46 | repository: schemacrawler/SchemaCrawler
47 | path: SchemaCrawler
48 | - id: build-schemacrawler
49 | name: Build SchemaCrawler for local Maven repository
50 | shell: bash
51 | run: |
52 | # Build SchemaCrawler
53 | cd SchemaCrawler
54 | mvn \
55 | --no-transfer-progress \
56 | --batch-mode \
57 | -DskipTests=true \
58 | clean install
59 |
60 | # VALIDATE OPENAPI SPECIFICATION
61 | - id: validate-oas
62 | name: Validate OpenAPI definition
63 | uses: swaggerexpert/swagger-editor-validate@v1
64 | with:
65 | swagger-editor-url: http://localhost/
66 | definition-file: src/main/resources/api/schemacrawler-web-application.yaml
67 |
68 | # BUILD AND TEST
69 | - id: build-test
70 | name: Build and run tests
71 | shell: bash
72 | run: |
73 | # Build
74 | mvn \
75 | --no-transfer-progress \
76 | --batch-mode \
77 | clean package
78 | - id: publish-test-results
79 | name: Upload results and coverage
80 | if: contains(github.ref, 'main')
81 | env:
82 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
83 | CODECOV_TOKEN: 350b716c-8f65-451b-b438-072f0662637d
84 | shell: bash
85 | run: |
86 | bash <(curl -s https://codecov.io/bash)
87 |
--------------------------------------------------------------------------------
/.github/workflows/release.yml:
--------------------------------------------------------------------------------
1 | name: Create Release
2 |
3 | on:
4 | workflow_dispatch:
5 | push:
6 | tags:
7 | - 'v*'
8 |
9 | concurrency:
10 | group: ${{ github.workflow }}-${{ github.ref }}
11 | cancel-in-progress: true
12 |
13 | jobs:
14 | build:
15 | name: Create Release
16 | runs-on: ubuntu-latest
17 | steps:
18 |
19 | # VALIDATE TAGS
20 | - id: validate-semver
21 | name: Validate tag against semantic versioning
22 | if: startsWith(github.ref, 'refs/tags/')
23 | shell: bash
24 | run: |
25 | SEMVER_PATTERN="^refs/tags/v(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$"
26 | if [[ ! $GITHUB_REF =~ $SEMVER_PATTERN ]]
27 | then
28 | echo "Tag $GITHUB_REF does not follow semantic versioning"
29 | exit 1
30 | fi
31 |
32 | # SETUP BUILD ENVIRONMENT
33 | - id: prepare-maven-build
34 | name: Prepare Maven build
35 | uses: sualeh/prepare-maven-build@v1.4.0
36 | with:
37 | java-version: 21
38 | - id: install-graphviz
39 | name: Install Graphviz
40 | uses: sualeh/install-graphviz@v1.0.3
41 |
42 | # BUILD FOR DISTRIBUTION
43 | # To build an image using Cloud Native Buildpacks for Spring Boot, provide
44 | # and additional -Ddocker.skip=false argument to the Maven build.
45 | - id: build
46 | name: Build and test for distribution
47 | shell: bash
48 | run: |
49 | # Build
50 | mvn \
51 | --no-transfer-progress \
52 | --batch-mode \
53 | clean install
54 |
55 | # CREATE GITHUB RELEASE AND ADD ASSETS
56 | - id: create-release
57 | name: Create GitHub release
58 | uses: actions/create-release@latest
59 | if: startsWith(github.ref, 'refs/tags/')
60 | env:
61 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
62 | with:
63 | tag_name: ${{ github.ref }}
64 | release_name: ${{ github.ref }}
65 | body: |
66 | SchemaCrawler Webapp Release ${{ github.sha }}
67 | draft: false
68 | prerelease: false
69 | - id: upload-release-zip
70 | name: Upload SchemaCrawler Webapp distribution
71 | uses: actions/upload-release-asset@latest
72 | if: startsWith(github.ref, 'refs/tags/')
73 | env:
74 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
75 | with:
76 | upload_url: ${{ steps.create-release.outputs.upload_url }}
77 | asset_path: ./target/schemacrawler-webapp-16.26.1-1.jar
78 | asset_name: schemacrawler-webapp-16.26.1-1.jar
79 | asset_content_type: application/zip
80 |
81 | # BUILD AND PUBLISH DOCKER IMAGE
82 | - id: setup-qemu
83 | name: Setup QEMU
84 | uses: docker/setup-qemu-action@v3
85 |
86 | - id: setup-buildx
87 | name: Setup Docker Buildx
88 | uses: docker/setup-buildx-action@v3
89 |
90 | - name: Log into Docker Hub
91 | uses: docker/login-action@v3
92 | with:
93 | username: ${{ secrets.DOCKER_USERNAME }}
94 | password: ${{ secrets.DOCKER_PASSWORD }}
95 |
96 | - name: Build and push Docker image
97 | uses: docker/build-push-action@v6
98 | with:
99 | file: ./Dockerfile
100 | context: .
101 | platforms: |-
102 | linux/amd64
103 | linux/arm64
104 | tags: |-
105 | schemacrawler/schemacrawler-webapp:v16.26.1-1
106 | schemacrawler/schemacrawler-webapp:latest
107 | sbom: true
108 | provenance: true
109 | push: true
110 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | target/
2 | !.mvn/wrapper/maven-wrapper.jar
3 | ~/
4 | *.versionsBackup
5 | tree.txt
6 |
7 | ### STS ###
8 | .apt_generated
9 | .classpath
10 | .factorypath
11 | .project
12 | .settings
13 | .springBeans
14 |
15 | ### IntelliJ IDEA ###
16 | .idea
17 | *.iws
18 | **/*.iml
19 | *.ipr
20 |
21 | ### NetBeans ###
22 | nbproject/private/
23 | build/
24 | nbbuild/
25 | dist/
26 | nbdist/
27 | .nb-gradle/
28 | /uploaded-files/
29 | keys.txt
30 | *.db
31 | *.png
32 | **/launch.json
33 |
34 | /src/test/postman/production.postman_environment.json
35 | application.log
36 | tree.txt
37 | /src/test/postman/api-*.json
38 |
--------------------------------------------------------------------------------
/.vscode/extensions.json:
--------------------------------------------------------------------------------
1 | {
2 | "recommendations": [
3 | "vscjava.vscode-java-debug"
4 | ]
5 | }
--------------------------------------------------------------------------------
/.vscode/settings.json:
--------------------------------------------------------------------------------
1 | {
2 | "scm.showInputActionButton": false,
3 | "git.showActionButton": {
4 | "commit": false,
5 | "publish": false,
6 | "sync": false
7 | },
8 | "git.postCommitCommand": "sync",
9 | "java.configuration.updateBuildConfiguration": "automatic",
10 | "java.compile.nullAnalysis.mode": "automatic",
11 | "editor.formatOnSave": false,
12 | "editor.formatOnType": true
13 | }
--------------------------------------------------------------------------------
/.vscode/workspace.code-workspace:
--------------------------------------------------------------------------------
1 | {
2 | "folders": [
3 | {
4 | "path": ".."
5 | }
6 | ],
7 | "settings": {
8 | "workbench.startupEditor": "none",
9 | "files.exclude": {
10 | "workspace": true
11 | },
12 | "java.configuration.updateBuildConfiguration": "automatic",
13 | "java.format.settings.profile": "GoogleStyle",
14 | "java.format.settings.url": "https://raw.githubusercontent.com/google/styleguide/gh-pages/eclipse-java-google-style.xml",
15 | "java.test.config": [
16 | {
17 | "name": "Standard",
18 | "workingDirectory": "${workspaceFolder}"
19 | },
20 | {
21 | "name": "Run Heavy Database Tests",
22 | "vmargs": [
23 | "-Dheavydb"
24 | ]
25 | }
26 | ],
27 | "editor.tabSize": 2,
28 | "editor.foldingImportsByDefault": true,
29 | "files.trimTrailingWhitespace": true,
30 | "git.enableCommitSigning": true
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
1 | # ========================================================================
2 | # SchemaCrawler
3 | # http://www.schemacrawler.com
4 | # Copyright (c) 2000-2025, Sualeh Fatehi