Updated links for linkchecker (#1539)

Signed-off-by: Ryan Bogan <rbogan@amazon.com>
This commit is contained in:
Ryan Bogan 2021-11-11 18:24:26 -05:00 committed by GitHub
parent c437b3442d
commit 01d1cb0ce6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 7 deletions

View File

@ -7,7 +7,7 @@
| Harold Wang | [harold-wang](https://github.com/harold-wang) | Amazon | | Harold Wang | [harold-wang](https://github.com/harold-wang) | Amazon |
| Himanshu Setia | [setiah](https://github.com/setiah) | Amazon | | Himanshu Setia | [setiah](https://github.com/setiah) | Amazon |
| Nick Knize | [nknize](https://github.com/nknize) | Amazon | | Nick Knize | [nknize](https://github.com/nknize) | Amazon |
| Rabi Panda | [adnapibar](adnapibar) | Amazon | | Rabi Panda | [adnapibar](https://github.com/adnapibar) | Amazon |
| Sarat Vemulapalli | [saratvemulapalli](https://github.com/saratvemulapalli) | Amazon | | Sarat Vemulapalli | [saratvemulapalli](https://github.com/saratvemulapalli) | Amazon |
| Tianli Feng | [tlfeng](https://github.com/tlfeng) | Amazon | | Tianli Feng | [tlfeng](https://github.com/tlfeng) | Amazon |
| Gopala Krishna Ambareesh | [krishna-ggk](https://github.com/krishna-ggk) |Amazon | | Gopala Krishna Ambareesh | [krishna-ggk](https://github.com/krishna-ggk) |Amazon |

View File

@ -46,7 +46,7 @@ Apache Ivy includes the following in its NOTICE file:
| The Apache Software Foundation (https://www.apache.org/). | The Apache Software Foundation (https://www.apache.org/).
| |
| Portions of Ivy were originally developed by | Portions of Ivy were originally developed by
| Jayasoft SARL (http://www.jayasoft.fr/) | Jayasoft SARL (http://www.jaya.free.fr/about.html)
| and are licensed to the Apache Software Foundation under the | and are licensed to the Apache Software Foundation under the
| "Software Grant License Agreement" | "Software Grant License Agreement"
| |

View File

@ -23,14 +23,14 @@ See the section in [TESTING.md](../../TESTING.md#testing-packaging)
When gradle runs the packaging tests on a VM, it runs the full suite by When gradle runs the packaging tests on a VM, it runs the full suite by
default. To add a test class to the suite, add its `class` to the default. To add a test class to the suite, add its `class` to the
`@SuiteClasses` annotation in [PackagingTests.java](src/main/java/org/opensearch/packaging/PackagingTests.java). `@SuiteClasses` annotation in [PackageTests.java](src/test/java/org/opensearch/packaging/test/PackageTests.java).
If a test class is added to the project but not to this annotation, it will not If a test class is added to the project but not to this annotation, it will not
run in CI jobs. The test classes are run in the order they are listed in the run in CI jobs. The test classes are run in the order they are listed in the
annotation. annotation.
## Choosing which distributions to test ## Choosing which distributions to test
Distributions are represented by [enum values](src/main/java/org/opensearch/packaging/util/Distribution.java) Distributions are represented by [enum values](src/test/java/org/opensearch/packaging/util/Distribution.java)
which know if they are compatible with the platform the tests are currently which know if they are compatible with the platform the tests are currently
running on. To skip a test if the distribution it's using isn't compatible with running on. To skip a test if the distribution it's using isn't compatible with
the current platform, put this [assumption](https://github.com/junit-team/junit4/wiki/assumptions-with-assume) the current platform, put this [assumption](https://github.com/junit-team/junit4/wiki/assumptions-with-assume)
@ -41,7 +41,7 @@ assumeTrue(distribution.packaging.compatible);
``` ```
Similarly if you write a test that is intended only for particular platforms, Similarly if you write a test that is intended only for particular platforms,
you can make an assumption using the constants and methods in [Platforms.java](src/main/java/org/opensearch/packaging/util/Platforms.java) you can make an assumption using the constants and methods in [Platforms.java](src/test/java/org/opensearch/packaging/util/Platforms.java)
```java ```java
assumeTrue("only run on windows", Platforms.WINDOWS); assumeTrue("only run on windows", Platforms.WINDOWS);
@ -73,14 +73,14 @@ public class MyTestDefaultTar extends MyTestCase {
``` ```
That way when a test fails the user gets told explicitly that `MyTestDefaultTar` That way when a test fails the user gets told explicitly that `MyTestDefaultTar`
failed, and to reproduce it they should run that class. See [ArchiveTestCase](src/main/java/org/opensearch/packaging/test/ArchiveTestCase.java) failed, and to reproduce it they should run that class. See [ArchiveTests](src/test/java/org/opensearch/packaging/test/ArchiveTests.java)
and its children for an example of this. and its children for an example of this.
## Running external commands ## Running external commands
In general it's probably best to avoid running external commands when a good In general it's probably best to avoid running external commands when a good
Java alternative exists. For example most filesystem operations can be done with Java alternative exists. For example most filesystem operations can be done with
the java.nio.file APIs. For those that aren't, use an instance of [Shell](src/main/java/org/opensearch/packaging/util/Shell.java) the java.nio.file APIs. For those that aren't, use an instance of [Shell](src/test/java/org/opensearch/packaging/util/Shell.java)
This class runs scripts in either bash with the `bash -c <script>` syntax, This class runs scripts in either bash with the `bash -c <script>` syntax,
or in powershell with the `powershell.exe -Command <script>` syntax. or in powershell with the `powershell.exe -Command <script>` syntax.