Merge pull request #1440 from njgheorghita/ethpm-contract-types-property

Ethpm contract types property

Author: njgheorghita

docs/ethpm.rst

@@ -47,7 +47,7 @@ Properties
 Each ``Package`` exposes the following properties.
 
 .. autoclass:: ethpm.Package
-   :members: name, version, manifest_version, uri, __repr__, build_dependencies, deployments
+   :members: name, version, manifest_version, uri, __repr__, contract_types, build_dependencies, deployments
 
 .. py:attribute:: Package.w3
 

ethpm/package.py

@@ -6,6 +6,7 @@
     Any,
     Dict,
     Generator,
+    List,
     Optional,
     Tuple,
     Union,
@@ -176,6 +177,16 @@ def uri(self) -> Optional[str]:
         """
         return self._uri
 
+    @property
+    def contract_types(self) -> List[str]:
+        """
+        All contract types included in this package.
+        """
+        if 'contract_types' in self.manifest:
+            return sorted(self.manifest['contract_types'].keys())
+        else:
+            return ValueError("No contract types found in manifest; {self.__repr__()}.")
+
     @classmethod
     def from_file(cls, file_path: Path, w3: Web3) -> "Package":
         """
@@ -202,7 +213,7 @@ def from_uri(cls, uri: URI, w3: Web3) -> "Package":
         URI schemes supported:
         - IPFS          `ipfs://Qm...`
         - HTTP          `https://api.github.com/repos/:owner/:repo/git/blobs/:file_sha`
-        - Registry      `ercXXX://registry.eth/greeter?version=1.0.0`
+        - Registry      `erc1319://registry.eth:1/greeter?version=1.0.0`
 
         .. code:: python
 
@@ -253,7 +264,7 @@ def get_contract_factory(self, name: ContractName) -> Contract:
             raise InsufficientAssetsError(
                 "This package does not contain any package data to generate "
                 f"a contract factory for contract type: {name}. Available contract types include: "
-                f"{ list(self.manifest['contract_types'].keys()) }."
+                f"{self.contract_types}."
             )
 
         validate_minimal_contract_factory_data(contract_data)
@@ -361,13 +372,12 @@ def deployments(self) -> Union["Deployments", Dict[None, None]]:
 
     @to_dict
     def _get_all_contract_instances(self, deployments):
-        contract_types = self.manifest['contract_types'].keys()
         for deployment_name, deployment_data in deployments.items():
-            if deployment_data['contract_type'] not in contract_types:
+            if deployment_data['contract_type'] not in self.contract_types:
                 raise EthPMValidationError(
                     f"Contract type: {deployment_data['contract_type']} for alias: "
                     f"{deployment_name} not found. Available contract types include: "
-                    f"{list(sorted(contract_types))}."
+                    f"{self.contract_types}."
                 )
             contract_instance = self.get_contract_instance(
                 deployment_data['contract_type'],

newsfragments/1440.feature.rst

@@ -0,0 +1 @@
+Add ``contract_types`` property to ``Package`` class.

tests/ethpm/test_package.py

@@ -86,3 +86,4 @@ def test_package_object_properties(safe_math_package):
     assert safe_math_package.manifest_version == "2"
     assert safe_math_package.uri is None
     assert safe_math_package.__repr__() == "<Package safe-math-lib==1.0.0>"
+    assert safe_math_package.contract_types == ["SafeMathLib"]

tests/ethpm/test_package_init_from_file.py renamed to tests/ethpm/test_package_init.py

@@ -9,6 +9,7 @@
     Package,
 )
 from ethpm.exceptions import (
+    CannotHandleURI,
     EthPMValidationError,
 )
 
@@ -95,3 +96,36 @@ def test_from_file_succeeds_with_valid_manifest(valid_manifest_from_path, w3):
 def test_from_file_raises_type_error_with_invalid_param_type():
     with pytest.raises(TypeError):
         Package.from_file(1)
+
+
+#
+# From URI
+#
+
+VALID_IPFS_PKG = "ipfs://QmeD2s7KaBUoGYTP1eutHBmBkMMMoycdfiyGMx2DKrWXyV"
+
+
+def test_package_from_uri_with_valid_uri(dummy_ipfs_backend, w3):
+    package = Package.from_uri(VALID_IPFS_PKG, w3)
+    assert package.name == "safe-math-lib"
+    assert isinstance(package, Package)
+
+
+@pytest.mark.parametrize(
+    "uri",
+    (
+        # Invalid
+        "123",
+        b"123",
+        "ipfs://",
+        "http://QmTKB75Y73zhNbD3Y73xeXGjYrZHmaXXNxoZqGCagu7r8u/readme",
+        "ipfsQmTKB75Y73zhNbD3Y73xeXGjYrZHmaXXNxoZqGCagu7r8u/readme/",
+        # Unsupported
+        "erc111://packages.zeppelin.os/owned",
+        "bzz://da6adeeb4589d8652bbe5679aae6b6409ec85a20e92a8823c7c99e25dba9493d",
+    ),
+)
+@pytest.mark.skipif('WEB3_INFURA_PROJECT_ID' not in os.environ, reason='Infura API key unavailable')
+def test_package_from_uri_rejects_invalid_ipfs_uri(uri, w3):
+    with pytest.raises(CannotHandleURI):
+        Package.from_uri(uri, w3)