Fixes for rc2 (#157)

Author: forsyth2

.github/workflows/build_workflow.yml

@@ -47,8 +47,7 @@ jobs:
 
       - name: Run Tests
         run: |
-          cd tests
-          python -m unittest
+          python -m unittest tests/test_*.py
 
   publish-docs:
     if: github.event_name == 'push'

LICENSE

@@ -27,4 +27,3 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-

NOTICE

@@ -19,4 +19,3 @@ The views and opinions of authors expressed herein do not necessarily
 state or reflect those of the United States Government or Lawrence
 Livermore National Security, LLC, and shall not be used for advertising
 or product endorsement purposes.
-

docs/source/dev_guide/release.rst

@@ -5,7 +5,6 @@ In this guide, we'll cover:
 
 * Preparing The Code For Release
 * Creating A Release On GitHub
-* Updating The sha256
 * Releasing The Software On Anaconda
 * Creating a New Version of the Documentation
 
@@ -106,48 +105,6 @@ Remember to write a description.
 
 3. Click "Publish release".
 
-Updating The sha256
---------------------
-
-1. Download "Source code (.tar.gz)" from the `GitHub releases page <https://github.com/E3SM-Project/zstash/releases>`_.
-
-2. Run ``shasum -a 256`` on this file. For example:
-
-    ::
-
-        shasum -a 256 zstash-0.4.1.tar.gz
-
-3. On your machine, pull the latest version of the code.
-This will have the ``conda/meta.yaml`` we edited in the first section.
-
-    ::
-
-        git checkout master
-        git pull <upstream-origin> master
-
-Or:
-    ::
-
-        git fetch <upstream-origin> master
-        git checkout -b <branch-name> <upstream-origin>/master
-
-4. Change ``sha256`` in ``conda/meta.yaml`` to the result of step 2.
-
-5. Commit and push your changes.
-
-    ::
-
-        git commit -am 'Edit sha256 for v0.4.1'
-        git push <upstream-origin> master
-
-Or:
-
-    ::
-
-        git commit -am 'Edit sha256 for v0.4.1'
-        git push <fork-origin> <branch-name>
-        # Create pull request for the master branch
-
 Releasing The Software On Anaconda
 ----------------------------------
 
@@ -158,6 +115,9 @@ This triggers the CI/CD workflow that handles Anaconda releases.
 
 3. Check the https://anaconda.org/e3sm/zstash page to view the newly updated package.
 
+   * Release candidates are assigned the ``e3sm_dev`` label
+   * Production releases are assigned the ``main`` label
+
 4. Notify the maintainers of the unified E3SM environment about the new release on the
 `E3SM Confluence site <https://acme-climate.atlassian.net/wiki/spaces/WORKFLOW/pages/129732419/E3SM+Unified+Anaconda+Environment>`_.
 Be sure to only update the ``zstash`` version number in the correct version(s) of

docs/source/usage.rst

@@ -11,6 +11,7 @@ If running on Cori, it is preferable to run from ``$CSCRATCH`` rather than
 .. note::
     If you have not logged into HSI before, you will have to do so before running ``zstash`` with HPSS.
     On NERSC machines, just run ``hsi`` on the command line and enter your credentials.
+    Note that ``hsi`` is only available on the log-in nodes, not the compute nodes.
 
 .. warning::
     When specifying files, wildcards should be enclosed in double quotes (e.g., ``"a*"``).

setup.py

@@ -6,6 +6,6 @@
     author="Ryan Forsyth, Chris Golaz, Zeshawn Shaheen",
     author_email="[email protected], [email protected], [email protected]",
     description="Long term HPSS archiving software for E3SM",
-    packages=find_packages(exclude=["*.test", "*.test.*", "test.*", "test"]),
+    packages=find_packages(include=["zstash", "zstash.*"]),
     entry_points={"console_scripts": ["zstash=zstash.main:main"]},
 )

tests/base.py

@@ -1,5 +1,5 @@
 """
-Run the test suite with `pip install .. && python -m unittest`
+Run the test suite with `python -m unittest tests/test_*.py`
 
 If running on Cori, it is preferable to run from $CSCRATCH rather than
 /global/homes. Running from the latter may result in a
@@ -12,10 +12,14 @@
 import unittest
 from collections import Counter
 
+# https://bugs.python.org/issue43743
+# error: Module has no attribute "_USE_CP_SENDFILE"
+shutil._USE_CP_SENDFILE = False  # type: ignore
+
 # The directory `zstash` is in. Set this if `zstash` is not in your PATH.
 ZSTASH_PATH = ""
 
-# Top level directory. Should end in `zstash/tests`.
+# Top level directory. Should end in `zstash`.
 # This is used to ensure we are changing into the correct subdirectories and parent directories.
 TOP_LEVEL = os.getcwd()
 
@@ -91,6 +95,7 @@ def setUp(self):
         """
         Set up a test. This is run before every test method.
         """
+        os.chdir(TOP_LEVEL)
         self.hpss_path = None
         self.cache = "zstash"
         self.test_dir = "zstash_test"
@@ -103,6 +108,7 @@ def tearDown(self):
 
         After the script has failed or completed, remove all created files, even those on the HPSS repo.
         """
+        os.chdir(TOP_LEVEL)
         print("Removing test files, both locally and at the HPSS repo")
         # self.cache may appear in any of these directories,
         # but should not appear at the same level as these.
@@ -137,7 +143,7 @@ def assertWorkspace(self):
         Assert that the code is being run from the correct directory.
         """
         actual = os.getcwd()
-        expected = "zstash/tests"
+        expected = "zstash"
         if not actual.endswith(expected):
             self.stop(
                 "Current_directory={} does not end in {}".format(actual, expected)

tests/test_check.py

@@ -14,6 +14,10 @@
     write_file,
 )
 
+# https://bugs.python.org/issue43743
+# error: Module has no attribute "_USE_CP_SENDFILE"
+shutil._USE_CP_SENDFILE = False  # type: ignore
+
 
 class TestCheck(TestZstash):
     """

tests/test_check_parallel.py

@@ -12,6 +12,10 @@
     run_cmd,
 )
 
+# https://bugs.python.org/issue43743
+# error: Module has no attribute "_USE_CP_SENDFILE"
+shutil._USE_CP_SENDFILE = False  # type: ignore
+
 
 class TestCheckParallel(TestZstash):
     """

tests/test_extract.py

@@ -12,6 +12,10 @@
     run_cmd,
 )
 
+# https://bugs.python.org/issue43743
+# error: Module has no attribute "_USE_CP_SENDFILE"
+shutil._USE_CP_SENDFILE = False  # type: ignore
+
 
 class TestExtract(TestZstash):
     """