Skip to content
Open
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 0 additions & 1 deletion .github/ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ Runs a subset of the following subjobs depending on what was selected by build-i
- author: [Verifies](../hadoop-ozone/dev-support/checks/author.sh) none of the Java files contain the @author annotation
- bats: [Checks](../hadoop-ozone/dev-support/checks/bats.sh) bash scripts, (using the [Bash Automated Testing System](https://github.com/bats-core/bats-core#bats-core-bash-automated-testing-system-2018))
- checkstyle: [Runs](../hadoop-ozone/dev-support/checks/checkstyle.sh) 'mvn checkstyle' plugin to confirm Java source abides by Ozone coding conventions
- docs: [Builds](../hadoop-ozone/dev-support/checks/docs.sh) website with [Hugo](https://gohugo.io/)
- findbugs: [Runs](../hadoop-ozone/dev-support/checks/findbugs.sh) spotbugs static analysis on bytecode
- pmd: [Runs](../hadoop-ozone/dev-support/checks/pmd.sh) PMD static analysis on project's source code
- rat (release audit tool): [Confirms](../hadoop-ozone/dev-support/checks/rat.sh) source files include licenses
Expand Down
13 changes: 6 additions & 7 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,20 +60,19 @@ server-side handling, client translation code, and integration tests.

Default local build flags:

- Use `-DskipShade -DskipRecon -DskipDocs` for iterative local work.
- Use `-DskipShade -DskipRecon` for iterative local work.
- Drop `-DskipShade` only when you need filesystem artifacts or tests that depend on the shaded Ozone FS jar.
- Drop `-DskipRecon` only when you are changing Recon UI or server behavior that must be built locally.
- Drop `-DskipDocs` only when you are changing docs or doc-generation logic.

Primary commands:

- Iterative full build: `mvn clean install -DskipTests -DskipShade -DskipRecon -DskipDocs`
- Full compile/verify smoke check: `mvn clean verify -DskipTests -DskipShade -DskipRecon -DskipDocs`
- Iterative full build: `mvn clean install -DskipTests -DskipShade -DskipRecon`
- Full compile/verify smoke check: `mvn clean verify -DskipTests -DskipShade -DskipRecon`
- Rebuild one module and its dependencies:
`mvn -pl :ozone-manager -am install -DskipTests -DskipShade -DskipRecon -DskipDocs`
- Run one unit test class: `mvn -pl :ozone-manager test -Dtest=TestOzoneManagerLock -DskipShade -DskipRecon -DskipDocs`
`mvn -pl :ozone-manager -am install -DskipTests -DskipShade -DskipRecon`
- Run one unit test class: `mvn -pl :ozone-manager test -Dtest=TestOzoneManagerLock -DskipShade -DskipRecon`
- Run one unit test method:
`mvn -pl :ozone-manager test -Dtest=TestOzoneManagerLock#testLockingOrder -DskipShade -DskipRecon -DskipDocs`
`mvn -pl :ozone-manager test -Dtest=TestOzoneManagerLock#testLockingOrder -DskipShade -DskipRecon`
- Run one integration test class:
`mvn -pl :ozone-integration-test test -Dtest=TestOmContainerLocationCache -DskipShade -DskipRecon`

Expand Down
5 changes: 2 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ We welcome contributions of:
* [All open and unassigned Ozone jiras](https://s.apache.org/OzoneUnassignedJiras)
* **Documentation Improvements**: You can submit improvements to either:
* Ozone website. Instructions are here: [Modifying the Ozone Website](https://cwiki.apache.org/confluence/display/OZONE/Modifying+the+Ozone+Website)
* Developer docs. These are markdown files [checked into the Apache Ozone Source tree](https://github.com/apache/ozone/tree/master/hadoop-hdds/docs/content).
* Developer design docs. These are markdown files [checked into the Apache Ozone Source tree](https://github.com/apache/ozone/tree/master/design).
* The [wiki pages](https://cwiki.apache.org/confluence/display/OZONE/Contributing+to+Ozone): Please contact us at dev@ozone.apache.org and we can provide you write access to the wiki.
* **Testing**: We always need help to improve our testing
* Unit Tests (JUnit / Java)
Expand Down Expand Up @@ -145,7 +145,6 @@ The [`hadoop-ozone/dev-support/checks` directory](https://github.com/apache/ozon
* `author.sh`: checks for `@author` tags
* `bats.sh`: unit test for shell scripts
* `rat.sh`: checks for Apache license header
* `docs.sh`: sanity checks for [Ozone documentation](https://github.com/apache/ozone/tree/master/hadoop-hdds/docs)
* `dependency.sh`: compares list of jars in build output with known list
* `checkstyle.sh`: Checkstyle
* `pmd.sh`: PMD
Expand All @@ -161,7 +160,7 @@ The set of tests run by `integration` and `acceptance` may be limited via argume

Some scripts require third-party tools, but most of these are installed during the first run, if needed.

Most scripts (except `build.sh`) output results in `target/<name>`, e.g. `target/docs`.
Most scripts (except `build.sh`) output results in `target/<name>`, e.g. `target/rat`.

## Using IDE

Expand Down
4 changes: 0 additions & 4 deletions LICENSE.txt
Original file line number Diff line number Diff line change
Expand Up @@ -225,13 +225,9 @@ MIT License
-----------

hadoop-hdds/framework/src/main/resources/webapps/static/bootstrap-3.4.1
hadoop-hdds/docs/themes/ozonedoc/static/css/bootstrap-*
hadoop-hdds/docs/themes/ozonedoc/static/js/bootstrap.min.js
hadoop-hdds/docs/themes/ozonedoc/static/fonts/glyphicons-*

hadoop-hdds/framework/src/main/resources/webapps/static/angular-route-1.8.0.min.js
hadoop-hdds/framework/src/main/resources/webapps/static/angular-nvd3-1.0.9.min.js
hadoop-hdds/framework/src/main/resources/webapps/static/angular-1.8.0.min.js

hadoop-hdds/framework/src/main/resources/webapps/static/jquery-3.5.1.min.js
hadoop-hdds/docs/themes/ozonedoc/static/js/jquery-3.5.1.min.js
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ To configure a Listener OM, you need to perform the following steps:

In this example, `om1`, `om2`, and `om3` are the voting OMs, and `om4` and `om5` are the Listener OMs.

2. **Bootstrap the Listener OM:** Before a new Listener OM can be started, it needs to be bootstrapped. This is the same process as bootstrapping a regular OM. For more details, please refer to the [OM High Availability]({{< ref "../feature/OM-HA.md#om-bootstrap" >}}) documentation.
2. **Bootstrap the Listener OM:** Before a new Listener OM can be started, it needs to be bootstrapped. This is the same process as bootstrapping a regular OM. For more details, please refer to the [OM High Availability](https://ozone.apache.org/docs/administrator-guide/configuration/high-availability/om-ha#om-bootstrap) documentation.



Expand All @@ -99,4 +99,4 @@ Listener OMs provide eventual consistency for read operations. This means that t

## References

* [Ozone Manager High Availability]({{< ref "../feature/OM-HA.md" >}})
* [Ozone Manager High Availability](https://ozone.apache.org/docs/administrator-guide/configuration/high-availability/om-ha)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
36 changes: 21 additions & 15 deletions dev-support/ci/selective_ci_checks.bats
Original file line number Diff line number Diff line change
Expand Up @@ -242,16 +242,22 @@ load bats-assert/load.bash
assert_output -p needs-kubernetes-tests=true
}

@test "docs only" {
run dev-support/ci/selective_ci_checks.sh 474457cb3

assert_output -p 'basic-checks=["rat","docs"]'
assert_output -p needs-build=false
assert_output -p needs-compile=false
assert_output -p needs-compose-tests=false
assert_output -p needs-integration-tests=false
assert_output -p needs-kubernetes-tests=false
}
# TODO: Re-enable as a "design only" test once a change under the top-level
# design/ directory is committed upstream. The former "docs only" case pinned
# commit 474457cb3, which only touched hadoop-hdds/docs (removed along with the
# Hugo site). No historical commit exercises the new ^design matcher, so update
# this to a design/-only commit SHA and assert basic-checks=["rat"] with all
# needs-* false.
# @test "design only" {
# run dev-support/ci/selective_ci_checks.sh <design-only-sha>
#
# assert_output -p 'basic-checks=["rat"]'
# assert_output -p needs-build=false
# assert_output -p needs-compile=false
# assert_output -p needs-compose-tests=false
# assert_output -p needs-integration-tests=false
# assert_output -p needs-kubernetes-tests=false
# }

@test "main/java change" {
run dev-support/ci/selective_ci_checks.sh 86a771dfe
Expand Down Expand Up @@ -289,7 +295,7 @@ load bats-assert/load.bash
@test "java and docs change" {
run dev-support/ci/selective_ci_checks.sh 2c0adac26

assert_output -p 'basic-checks=["rat","author","checkstyle","docs","findbugs","pmd"]'
assert_output -p 'basic-checks=["rat","author","checkstyle","findbugs","pmd"]'
assert_output -p needs-build=true
assert_output -p needs-compile=true
assert_output -p needs-compose-tests=true
Expand All @@ -311,7 +317,7 @@ load bats-assert/load.bash
@test "CI lib change" {
run dev-support/ci/selective_ci_checks.sh ceb79acaa

assert_output -p 'basic-checks=["author","bats","checkstyle","docs","findbugs","pmd","rat"]'
assert_output -p 'basic-checks=["author","bats","checkstyle","findbugs","pmd","rat"]'
assert_output -p needs-build=true
assert_output -p needs-compile=true
assert_output -p needs-compose-tests=true
Expand All @@ -322,7 +328,7 @@ load bats-assert/load.bash
@test "CI workflow change" {
run dev-support/ci/selective_ci_checks.sh 90a8d7c01

assert_output -p 'basic-checks=["author","bats","checkstyle","docs","findbugs","pmd","rat"]'
assert_output -p 'basic-checks=["author","bats","checkstyle","findbugs","pmd","rat"]'
assert_output -p needs-build=true
assert_output -p needs-compile=true
assert_output -p needs-compose-tests=true
Expand All @@ -345,7 +351,7 @@ load bats-assert/load.bash
@test "CI workflow change (check.yml)" {
run dev-support/ci/selective_ci_checks.sh 1468af02067ec75b255f605816c32f8bf4dfaabf

assert_output -p 'basic-checks=["author","bats","checkstyle","docs","findbugs","pmd","rat"]'
assert_output -p 'basic-checks=["author","bats","checkstyle","findbugs","pmd","rat"]'
assert_output -p needs-build=true
assert_output -p needs-compile=true
assert_output -p needs-compose-tests=true
Expand All @@ -356,7 +362,7 @@ load bats-assert/load.bash
@test "CI workflow change (ci.yaml)" {
run dev-support/ci/selective_ci_checks.sh 90fd5f2adc

assert_output -p 'basic-checks=["author","bats","checkstyle","docs","findbugs","pmd","rat"]'
assert_output -p 'basic-checks=["author","bats","checkstyle","findbugs","pmd","rat"]'
assert_output -p needs-build=true
assert_output -p needs-compile=true
assert_output -p needs-compose-tests=true
Expand Down
23 changes: 8 additions & 15 deletions dev-support/ci/selective_ci_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ function filter_changed_files() {

SOURCES_TRIGGERING_TESTS=(
"^.github"
"^design"
"^dev-support"
"^hadoop-hdds"
"^hadoop-ozone"
Expand Down Expand Up @@ -244,16 +245,15 @@ function get_count_compose_files() {
start_end::group_end
}

function get_count_doc_files() {
start_end::group_start "Count doc files"
# Design docs in the top-level design/ directory are handled by the
# rat basic check only; adding them to matched_files keeps them from triggering
# the functional test matrix.
function get_count_design_files() {
start_end::group_start "Count design doc files"
local pattern_array=(
"^hadoop-hdds/docs"
"^hadoop-ozone/dev-support/checks/docs.sh"
"^hadoop-ozone/dev-support/checks/install/hugo.sh"
"^design"
)
filter_changed_files true
COUNT_DOC_CHANGED_FILES=${match_count}
readonly COUNT_DOC_CHANGED_FILES
start_end::group_end
}

Expand Down Expand Up @@ -398,12 +398,6 @@ function check_needs_checkstyle() {
start_end::group_end
}

function check_needs_docs() {
if [[ ${COUNT_DOC_CHANGED_FILES} != "0" ]]; then
add_basic_check docs
fi
}

function check_needs_findbugs() {
start_end::group_start "Check if findbugs is needed"
local pattern_array=(
Expand Down Expand Up @@ -565,7 +559,7 @@ run_all_tests_if_environment_files_changed

get_count_all_files
get_count_compose_files
get_count_doc_files
get_count_design_files
get_count_integration_files
get_count_kubernetes_files
get_count_robot_files
Expand All @@ -579,7 +573,6 @@ BASIC_CHECKS="rat"
check_needs_author
check_needs_bats
check_needs_checkstyle
check_needs_docs
check_needs_findbugs
check_needs_pmd
calculate_test_types_to_run
Expand Down
4 changes: 0 additions & 4 deletions dev-support/rat/rat-exclusions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,6 @@ src/test/resources/incorrect.checksum.container
src/test/resources/incorrect.container
src/test/resources/test.db.ini

# hadoop-hdds/docs
**/themes/ozonedoc/**
static/slides/*

# hadoop-ozone/dist
**/.ssh/id_rsa*
**/log.html
Expand Down
11 changes: 0 additions & 11 deletions hadoop-hdds/container-service/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -198,11 +198,6 @@
<groupId>org.yaml</groupId>
<artifactId>snakeyaml</artifactId>
</dependency>
<dependency>
<groupId>org.apache.ozone</groupId>
<artifactId>hdds-docs</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.github.luben</groupId>
<artifactId>zstd-jni</artifactId>
Expand Down Expand Up @@ -326,12 +321,6 @@
<outputDirectory>${project.build.outputDirectory}</outputDirectory>
<includes>webapps/static/**/*.*</includes>
</artifactItem>
<artifactItem>
<groupId>org.apache.ozone</groupId>
<artifactId>hdds-docs</artifactId>
<outputDirectory>${project.build.outputDirectory}/webapps/hddsDatanode</outputDirectory>
<includes>docs/**/*.*</includes>
</artifactItem>
</artifactItems>
<overWriteSnapshots>true</overWriteSnapshots>
</configuration>
Expand Down
2 changes: 0 additions & 2 deletions hadoop-hdds/docs/.gitignore

This file was deleted.

55 changes: 0 additions & 55 deletions hadoop-hdds/docs/README.md

This file was deleted.

20 changes: 0 additions & 20 deletions hadoop-hdds/docs/archetypes/default.md

This file was deleted.

Loading