Gateway

Microservice to expose main CapyFile services.

Documentation

Document	URL
CLI documentation	CLI.md
CICD	CICD.md
CONTRIBUTING	CONTRIBUTING.md
SOAP Java interfaces	Service.java
SOAP service API definition	Specification

Development

Submodules

Fetch submodules after cloning:

git clone https://github.com/hawks-atlanta/gateway-java
git submodule update --init

Tools

• Have jdk11 or newer installed.

• (Optional) Use the gradle wrapper script (./gradlew) for all gradle commands. For example:

  ./gradlew run

• (Optional) Use the provided nix-shell to get into a shell with all required dependecies [install Nix].

  nix-shell

Run

gradle run

Run tests

gradle test # only run tests
gradle testCodeCoverageReport # run tests & generate coverage

# rerun tests
gradle cleanTest test
gradle cleanTest testCodeCoverageReport

See test results

app/build/reports/tests/test/index.html # general
app/build/reports/jacoco/testCodeCoverageReport/html/index.html # coverage

Format

You need to have clang-format installed.

./format.sh clang-check # check (doesn't write)
./format.sh clang-format # apply (writes)

Coverage