diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 00000000..95911c4f
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,60 @@
+
+
+
+
+Pull Request (PR) draft checklist - click to expand
+
+- [ ] Please review our
+ [contributing documentation](https://earthaccess.readthedocs.io/en/latest/contributing/)
+ before getting started.
+- [ ] Ensure an issue exists representing the problem being solved in this PR.
+- [ ] Populate a descriptive title. For example, instead of "Updated README.md", use a
+ title such as "Add testing details to the contributor section of the README".
+- [ ] Populate the body of the pull request with:
+ - A clear description of the change you are proposing.
+ - Links to any issues resolved by this PR with text in the PR description, for
+ example `closes #1`. See
+ [GitHub docs - Linking a pull request to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
+- [ ] Update `CHANGELOG.md` with details about your change in a section titled
+ `## Unreleased`. If such a section does not exist, please create one. Follow
+ [Common Changelog](https://common-changelog.org/) for your additions.
+- [ ] Update the documentation and/or the `README.md` with details of changes to the
+ earthaccess interface, if any. Consider new environment variables, function names,
+ decorators, etc.
+
+Click the "Ready for review" button at the bottom of the "Conversation" tab in GitHub
+once these requirements are fulfilled. Don't worry if you see any test failures in
+GitHub at this point!
+
+Pull Request (PR) merge checklist - click to expand
+
+Please do your best to complete these requirements! If you need help with any of these
+requirements, you can ping the `@nsidc/earthaccess-support` team in a comment and we
+will help you out!
+
+- [ ] Add unit tests for any new features.
+- [ ] Apply formatting and linting autofixes. You can add a GitHub comment in this Pull
+ Request containing "pre-commit.ci autofix" to automate this.
+- [ ] Ensure all automated PR checks (seen at the bottom of the "conversation" tab) pass.
+- [ ] Get at least one approving review.
+
+![](\"https://www.nasa.gov/sites/default/files/styles/full_width/public/thumbnails/image/sealevel_main-causes3-16.jpg?itok=XAqGqps1\")
\n",
+ "![\"Sea](\"https://www.nasa.gov/wp-content/uploads/2020/08/sealevel_main-causes3-16.jpg\")
\n",
"\n",
"--- \n",
"\n",
@@ -157,11 +157,11 @@
" * not fully tested with Dask distributed\n",
"* Data is gridded\n",
" * xarray works better with homogeneous coordinates, working with swath data will be cumbersome.\n",
- "* Data is chunked using reasonable large sizes(1MB or more)\n",
+ "* Data is chunked using reasonable large sizes (1MB or more)\n",
" * If our files are chunked in small pieces the access time will be orders of magnitude bigger than just downloading the data and accessing it locally.\n",
" \n",
- "Opening a year of SSH (SEA_SURFACE_HEIGHT_ALT_GRIDS_L4_2SATS_5DAY_6THDEG_V_JPL1812) data (1.1 GB approx) can take up to 5 minutes streaming the data out of region(not in AWS)\n",
- "The reason for this is not that the data transfer is order of magintude slower but due the client libraries not fetching data concurrently and the metadata of the files in HDF is usually not consolidated like in Zaar, hence h5netcdf has to issue a lot of requests to get the info it needs.\n",
+ "Opening a year of SSH (SEA_SURFACE_HEIGHT_ALT_GRIDS_L4_2SATS_5DAY_6THDEG_V_JPL1812) data (1.1 GB approx) can take up to 5 minutes streaming the data out of region (not in AWS)\n",
+ "The reason for this is not that the data transfer is order of magnitude slower but due the client libraries not fetching data concurrently and the metadata of the files in HDF is usually not consolidated like in Zaar, hence h5netcdf has to issue a lot of requests to get the info it needs.\n",
"\n",
"> Note: we are looping through each year and getting the metadata for the first granule in May"
]
@@ -195,7 +195,7 @@
"id": "8b63ca2f-c94c-4d4a-a620-a086ee66137f",
"metadata": {},
"source": [
- "### What `earthaccess.open()` do?\n",
+ "### What does `earthaccess.open()` do?\n",
"\n",
"`earthaccess.open()` takes a list of results from `earthaccess.search_data()` or a list of URLs and creates a list of Python File-like objects that can be used in our code as if the remote files were local. When executed in AWS the file system used is [S3FS](https://github.com/fsspec/s3fs) when we open files outside of AWS we get a regular HTTPS file session. \n"
]
diff --git a/earthaccess/api.py b/earthaccess/api.py
index 8522dbbb..0418d69f 100644
--- a/earthaccess/api.py
+++ b/earthaccess/api.py
@@ -68,7 +68,9 @@ def search_datasets(count: int = -1, **kwargs: Any) -> List[DataCollection]:
```
"""
if not validate.valid_dataset_parameters(**kwargs):
- logger.warn("A valid set of parameters is needed to search for datasets on CMR")
+ logger.warning(
+ "A valid set of parameters is needed to search for datasets on CMR"
+ )
return []
if earthaccess.__auth__.authenticated:
query = DataCollections(auth=earthaccess.__auth__).parameters(**kwargs)
diff --git a/earthaccess/store.py b/earthaccess/store.py
index 147e6ce8..f3b1054c 100644
--- a/earthaccess/store.py
+++ b/earthaccess/store.py
@@ -113,7 +113,7 @@ def __init__(self, auth: Any, pre_authorize: bool = False) -> None:
self.set_requests_session(url)
else:
- logger.warn("The current session is not authenticated with NASA")
+ logger.warning("The current session is not authenticated with NASA")
self.auth = None
self.in_region = self._running_in_us_west_2()
diff --git a/pyproject.toml b/pyproject.toml
index 0e15f45d..316a4ac7 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -144,8 +144,8 @@ line-length = 88
src = ["earthaccess", "stubs", "tests"]
[tool.ruff.lint]
-extend-select = ["I", "T20", "D"]
-ignore = ["D1", "D205", "D401", "D417"]
+extend-select = ["I", "T20", "D", "G"]
+ignore = ["D1", "D205", "D401", "D417", "G004"]
[tool.ruff.lint.pydocstyle]
convention = "google"
diff --git a/scripts/integration-test.sh b/scripts/integration-test.sh
index 2d55064f..7a7b6551 100755
--- a/scripts/integration-test.sh
+++ b/scripts/integration-test.sh
@@ -1,7 +1,18 @@
#!/usr/bin/env bash
-set -e
set -x
+pytest tests/integration --cov=earthaccess --cov=tests/integration --cov-report=term-missing ${@} --capture=no --tb=native --log-cli-level=INFO
+RET=$?
+set +x
+
+set -e
+# NOTE: 99 is a special return code we selected for this case, it has no other meaning.
+if [[ $RET == 99 ]]; then
+ echo -e "\e[0;31mWARNING: The integration test suite has been permitted to return 0 because the failure rate was less than a hardcoded threshold.\e[0m"
+ echo "For more details, see conftest.py."
+ exit 0
+elif [[ $RET != 0 ]]; then
+ exit $RET
+fi
-pytest --cov=earthaccess --cov=tests/integration --cov-report=term-missing ${@} -s --tb=native --log-cli-level=INFO
bash ./scripts/lint.sh
diff --git a/tests/integration/conftest.py b/tests/integration/conftest.py
index 8be3de59..c2d4a3c2 100644
--- a/tests/integration/conftest.py
+++ b/tests/integration/conftest.py
@@ -5,8 +5,27 @@
@pytest.hookimpl()
def pytest_sessionfinish(session, exitstatus):
- if exitstatus == 0:
+ """Return exit code 99 if up to N% of tests have failed.
+
+ N = ACCEPTABLE_FAILURE_RATE
+
+ 99 was chosen arbitrarily to avoid conflict with current and future pytest error
+ codes (https://docs.pytest.org/en/stable/reference/exit-codes.html), and avoid
+ other exit codes with special meanings
+ (https://tldp.org/LDP/abs/html/exitcodes.html).
+
+ IMPORTANT: This is calculated against every test collected in the session, so the
+ ratio will change depending on which tests are executed! E.g. executing integration
+ tests and unit tests at the same time allows more tests to fail than executing
+ integration tests alone.
+ """
+ if exitstatus != pytest.ExitCode.TESTS_FAILED:
+ # Exit status 1 in PyTest indicates "Tests were collected and run but some of
+ # the tests failed". In all other cases, for example "an internal error happened
+ # while executing the tests", or "test execution interrupted by the user", we
+ # want to defer to original pytest behavior.
return
+
failure_rate = (100.0 * session.testsfailed) / session.testscollected
if failure_rate <= ACCEPTABLE_FAILURE_RATE:
- session.exitstatus = 0
+ session.exitstatus = 99