Merge pull request #29 from uc-cdis/feat/PXP-6421-Add-description-to-indexd

feat(PXP-6421): Add description for indexd records

Author: k-burt-uch

.gitignore

@@ -1,3 +1,4 @@
 *.pyc
 *.egg-info
 .pytest_cache/
+.idea

.pre-commit-config.yaml

@@ -13,6 +13,6 @@ repos:
     -   id: no-commit-to-branch
         args: [--branch, develop, --branch, master, --branch, main, --pattern, release/.*]
 -   repo: https://github.com/psf/black
-    rev: 20.8b1
+    rev: 22.3.0
     hooks:
     -   id: black

README.md

@@ -4,7 +4,7 @@ Test data and reusable non-specific test code
 
 ## fixtures
 
-Fixtures allow us to reuse similiar code between many tests.
+Fixtures allow us to reuse similar code between many tests.
 Read all about it [here](https://docs.pytest.org/en/latest/fixture.html)
 
 ### Indexd

cdisutilstest/code/dictionary_submission.py

@@ -77,7 +77,6 @@ def project_creation_endpoint_helper(
 def put_entity_creation_valid_helper(
     client, pg_driver, submitter, program, project, data_dir, schema_path
 ):
-
     put_program_project(client, program, project, data_dir, auth=submitter)
 
     entities = os.listdir(schema_path)

cdisutilstest/code/indexd_fixture.py

@@ -115,6 +115,7 @@ def create_random_index(index_client, did=None, version=None, hashes=None):
         urls_metadata={
             "s3://super-safe.com/{}_warning_huge_file.svs".format(did): {"a": "b"}
         },
+        description="a description",
     )
 
     return doc
@@ -153,6 +154,7 @@ def create_random_index_version(index_client, did, version_did=None, version=Non
     data["urls_metadata"] = {
         "s3://super-safe.com/{}_warning_huge_file.svs".format(did): {"a": "b"}
     }
+    data["description"] = "a description"
 
     if version:
         data["version"] = version

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name="cdisutilstest",
-    version="0.2.4",
+    version="0.3.0",
     description="Collection of test data and tools",
     license="Apache",
     packages=find_packages(),