Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ jobs:
- name: Build and Run Tests
shell: bash
run: |
./gradlew check -x integTest -x yamlRestTest -x spotlessJava "-Pcrypto.standard=FIPS-140-3"
./gradlew check -x integTest -x yamlRestTest -x spotlessJava
- name: Upload Coverage Report
if: contains(matrix.os, 'ubuntu') && contains(matrix.java, '21')
uses: codecov/codecov-action@v5
Expand All @@ -80,7 +80,7 @@ jobs:
- name: Build and Run Tests
shell: bash
run: |
./gradlew integTest yamlRestTest "-Pcrypto.standard=FIPS-140-3"
./gradlew integTest yamlRestTest
integMultiNodeTest:
needs: [spotless, javadoc]
strategy:
Expand All @@ -100,7 +100,7 @@ jobs:
- name: Build and Run Tests
shell: bash
run: |
./gradlew integTest -PnumNodes=3 "-Pcrypto.standard=FIPS-140-3"
./gradlew integTest -PnumNodes=3
integTenantAwareTest:
needs: [spotless, javadoc]
strategy:
Expand All @@ -123,4 +123,4 @@ jobs:
- name: Build and Run Tests
shell: bash
run: |
./gradlew integTest "-Dtests.rest.tenantaware=true" "-Pcrypto.standard=FIPS-140-3"
./gradlew integTest "-Dtests.rest.tenantaware=true"
2 changes: 1 addition & 1 deletion .github/workflows/publish-snapshots.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ jobs:

- name: publish snapshots to maven
run: |
./gradlew publishPluginZipPublicationToSnapshotsRepository "-Pcrypto.standard=FIPS-140-3"
./gradlew publishPluginZipPublicationToSnapshotsRepository
4 changes: 2 additions & 2 deletions .github/workflows/test_bwc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
run: |
plugin_version=`./gradlew properties -q | grep "opensearch_build:" | awk '{print $2}'`
echo plugin_version $plugin_version
./gradlew assemble "-Pcrypto.standard=FIPS-140-3"
./gradlew assemble
echo "Creating ./src/test/resources/org/opensearch/flowframework/bwc/flow-framework/$plugin_version ..."
mkdir -p ./src/test/resources/org/opensearch/flowframework/bwc/flow-framework/$plugin_version
echo "Copying ./build/distributions/*.zip to ./src/test/resources/org/opensearch/flowframework/bwc/flow-framework/$plugin_version ..."
Expand All @@ -44,4 +44,4 @@ jobs:
- name: Run Flow Framework Backwards Compatibility Tests
run: |
echo "Running backwards compatibility tests ..."
./gradlew bwcTestSuite -Dtests.security.manager=false "-Pcrypto.standard=FIPS-140-3"
./gradlew bwcTestSuite -Dtests.security.manager=false
1 change: 0 additions & 1 deletion .github/workflows/test_security.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,4 @@ jobs:
-Dsecurity.enabled=true \
-Dhttps=true \
-Dresource_sharing.enabled=${{ matrix.resource_sharing_flag }} \
\"-Pcrypto.standard=FIPS-140-3\" \
--tests '*IT'"
10 changes: 10 additions & 0 deletions DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
- [Java](#java)
- [Setup](#setup)
- [Build](#build)
- [FIPS Crypto Configuration](#fips-crypto-configuration)
- [Building from the command line](#building-from-the-command-line)
- [Building from the IDE](#building-from-the-ide)
- [Backports](#backports)
Expand Down Expand Up @@ -36,6 +37,15 @@ The Flow Framework `main` branch targets JDK 21. To ease backporting to `2.x`, m

This package uses the [Gradle](https://docs.gradle.org/current/userguide/userguide.html) build system. Gradle comes with excellent documentation that should be your first stop when trying to figure out how to operate or modify the build. we also use the OpenSearch build tools for Gradle. These tools are idiosyncratic and don't always follow the conventions and instructions for building regular Java code using Gradle. Not everything in this package will work the way it's described in the Gradle documentation. If you encounter such a situation, the OpenSearch build tools [source code](https://github.com/opensearch-project/OpenSearch/tree/main/buildSrc/src/main/groovy/org/opensearch/gradle) is your best bet for figuring out what's going on.

#### FIPS Crypto Configuration

The `gradle.properties` file includes `crypto.standard=FIPS-140-3` by default, so there is no need to pass `-Pcrypto.standard=FIPS-140-3` on the command line. All build and test commands automatically use this setting.

To build without FIPS, override the property:
```
./gradlew assemble -Pcrypto.standard=any-supported
```

#### Building from the command line

1. `./gradlew check` builds and tests.
Expand Down
1 change: 1 addition & 0 deletions gradle.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
crypto.standard=FIPS-140-3
Loading