Don't run EmptyDirTaskTests in a Docker container

[dbwiddis]

Signed-off-by: Daniel Widdis [email protected]

Description

Docker doesn't provide the permissions to test EmptyDirTask. Similar to the Windows OS, the test should not run if it detects that environment.

The primary/reliable/consistent test of whether in a Docker container is the presence of a .dockerenv file in the root directory. There was mention in 2016 that this could in theory be removed in the future but it's still present 6 years later and other proposed alternatives are not consistently valid in 2022. I added two potential backup tests.

Issues Resolved

Fixes #3674

Check List

• New functionality includes testing.
  • All tests pass
• New functionality has been documented.
  • New functionality has javadoc added
• Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/196/
• CommitID: cb96c2f

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/206/
• CommitID: b29938f

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: SUCCESS ✅
• URL: https://build.ci.opensearch.org/job/gradle-check/209/
• CommitID: 04932ce

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/308/
• CommitID: 29ad2b5

[owaiskazi19]

@dbwiddis Precommit failed

/home/runner/work/OpenSearch/OpenSearch/buildSrc/src/test/java/org/opensearch/gradle/EmptyDirTaskTests.java:96: error: cannot find symbol
    private File getNewNonExistingTempFolderFile(Project project) throws IOException {
> Task :buildSrc:compileTestJava
                                                 ^
  symbol:   class Project
  location: class EmptyDirTaskTests
/home/runner/work/OpenSearch/OpenSearch/buildSrc/src/test/java/org/opensearch/gradle/EmptyDirTaskTests.java:49: error: cannot find symbol
        Project project = ProjectBuilder.builder().build();
        ^
  symbol:   class Project
  location: class EmptyDirTaskTests
/home/runner/work/OpenSearch/OpenSearch/buildSrc/src/test/java/org/opensearch/gradle/EmptyDirTaskTests.java:76: error: cannot find symbol
        Project project = ProjectBuilder.builder().build();
        ^
  symbol:   class Project
  location: class EmptyDirTaskTests
Note: Some input files use or override a deprecated API.
> Task :buildSrc:compileTestJava FAILED

[dbwiddis]

@dbwiddis Precommit failed

The perils of editing on my home machine where I hadn't suppressed save actions and it went crazy. All fixed now.

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/310/
• CommitID: 4cc7ed1

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: SUCCESS ✅
• URL: https://build.ci.opensearch.org/job/gradle-check/311/
• CommitID: 8be1706

[codecov-commenter]

Codecov Report

❗ No coverage uploaded for pull request base (main@289c2d3). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #3792   +/-   ##
=======================================
  Coverage        ?   70.57%           
  Complexity      ?    56709           
=======================================
  Files           ?     4557           
  Lines           ?   272681           
  Branches        ?    40038           
=======================================
  Hits            ?   192456           
  Misses          ?    63971           
  Partials        ?    16254           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 289c2d3...8be1706. Read the comment docs.

[owaiskazi19]

LGTM! Thanks for the changes

[dbwiddis]

Hi @reta, let me know if I need to make any changes here!

[reta]

Hi @reta, let me know if I need to make any changes here!

LGTM, I don't know better way to detect if JVM is running in Docker or not ...