Refactor resources tests - integrate versions and improve test coverage

CHANGELOG.md

@@ -14,15 +14,23 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 - [Tests] Separate testing of `bytes` and `str` type values for Python 3+. [#286]
 - [Tests] Mark tests requiring updates when adding a new version. [#288]
 - [Tests] Add another build stage to check that docs build when merging to dev or master. [#292]
+- [Tests] Significantly improve test coverage of the `resources` module. [#297]
 
 ### Changed
 
+- [Resources] Change the folder containing version-independent data from `version-independent` to `version_independent` for consistency. [#297]
+- [Resources] `create_*_path()` functions will raise errors when given an unknown version. [#297]
+- [Resources] `get_*_paths()` functions now verify that paths point to actual files before returning them. [#297]
+- [Resources] `get_*_paths()` functions raise errors when given values that cannot represent a version. [#297]
+
 - [Utilities] Raise a TypeError rather than a ValueError when `convert_xml_to_tree()` is given a value of incorrect type. [#286]
 
 ### Deprecated
 
 ### Removed
 
+- [Resources] Functions in the `resources` module no longer have default values for the `version` argument. [#297]
+
 ### Fixed
 
 - [Validation] The `_check_codes()` implementation is no longer fixed to version 2.02. [#291]

iati/default.py

@@ -202,7 +202,7 @@ def ruleset_schema():
         Determine whether a version should be provided. This is worth considering if the content of the IATI Ruleset Schema varies between versions.
 
     """
-    path = iati.resources.create_ruleset_path(iati.resources.FILE_RULESET_SCHEMA_NAME)
+    path = iati.resources.create_ruleset_path(iati.resources.FILE_RULESET_SCHEMA_NAME, iati.version.STANDARD_VERSION_ANY)
     schema_str = iati.utilities.load_as_string(path)
 
     return json.loads(schema_str)

iati/tests/conftest.py

@@ -9,6 +9,7 @@
 
 pytest_plugins = [  # name required by pytest  # pylint: disable=invalid-name
     'iati.tests.fixtures.comparison',
+    'iati.tests.fixtures.filepaths',
     'iati.tests.fixtures.versions'
 ]
 
@@ -30,7 +31,9 @@ def pytest_runtest_call(item):
     ('2.02', 62),  # There are 38 embedded codelists at v2.02, plus 24 non-embedded codelists (which are valid for any version)
     ('2.01', 61),  # There are 37 embedded codelists at v2.01, plus 24 non-embedded codelists (which are valid for any version)
     ('1.05', 59),  # There are 35 embedded codelists at v1.05, plus 24 non-embedded codelists (which are valid for any version)
-    ('1.04', 59)  # There are 35 embedded codelists at v1.04, plus 24 non-embedded codelists (which are valid for any version)
+    ('1.04', 59),  # There are 35 embedded codelists at v1.04, plus 24 non-embedded codelists (which are valid for any version)
+    ('2', 62),  # the same as the latest minor within the major
+    ('1', 59)  # the same as the latest minor within the major
 ])
 def codelist_lengths_by_version(request):  # latest_version fixture used to perform checks when adding new versions  # pylint: disable=unused-argument
     """Return a tuple containing versions of the Standard, and the number of Codelists for that version.

iati/tests/fixtures/filepaths.py

@@ -0,0 +1,57 @@
+"""Pytest fixtures for obtaining filepaths."""
+import os
+import pytest
+import iati.tests.utilities
+
+
+@pytest.fixture(params=[
+    'filename-no-extension',
+    'filename-with-extension.ext',
+    'FilenameMixedCase'
+])
+def filename_no_meaning(request):
+    """Return a filename with no particular meaning."""
+    return request.param
+
+
+@pytest.fixture(params=[
+    'a-single-filename'
+])
+def filename_no_meaning_single(request):
+    """Return a single filename with no particular meaning."""
+    return request.param
+
+
+@pytest.fixture(params=iati.tests.utilities.generate_test_types(['str'], True))
+def filepath_invalid_type(request):
+    """Return a value that is of a type that cannot represent a filepath.
+
+    Python2/3 compatibility: Look at using the concept of PathLike that was introduced at 3.4.
+    """
+    return request.param
+
+
+@pytest.fixture
+def filepath_empty():
+    """Return a value that is an empty filepath."""
+    return ''
+
+
+@pytest.fixture(params=[
+    ' ',  # whitespace only
+    '\ntext-with-newline\n',  # newline
+    os.path.sep * 3  # multiple separators, each with nothing between them
+])
+def filepath_invalid_value(request):
+    """Return a value that is a string that cannot represent a filepath."""
+    return request.param
+
+
+@pytest.fixture(params=[
+    'foldername' + os.path.sep,
+    'foldername-with-hyphen' + os.path.sep,
+    'folder' + os.path.sep + 'sub-folder' + os.path.sep
+])
+def folderpath_no_meaning(request):
+    """Return a folder path with no particular meaning. Differs from a filepath in that it contains separators."""
+    return request.param

iati/tests/fixtures/versions.py

@@ -12,6 +12,7 @@
   * `major` - major / integer versions
   * `minor` - minor / decimal versions
   * `all` - both major and minor versions
+  * `any` - both major and minor versions, plus the value that represents every single version
   * `independent` - a value that represents every single version
 * Instantiation Status
   * `inst` - an iati.Version instance
@@ -237,12 +238,18 @@ def std_ver_minor_uninst_typeerr(request):
     return request.param
 
 
-@pytest.fixture(params=iati.tests.utilities.generate_test_types([], True))
+@pytest.fixture(params=MINOR_MIXED_VER_INVALID + MAJOR_INVALID + MAJOR_VALID + iati.tests.utilities.generate_test_types([], True))
 def std_ver_minor_uninst_mixederr(request):
     """Return a value that does not represent a minor version number."""
     return request.param
 
 
+@pytest.fixture(params=MINOR_MIXED_VER_INVALID + MAJOR_INVALID)
+def std_ver_all_uninst_valueerr(request):
+    """Return a value of the correct type to represent a version number, but has an invalid value."""
+    return request.param
+
+
 @pytest.fixture(params=iati.tests.utilities.generate_test_types(['str', 'int'], True))
 def std_ver_all_uninst_typeerr(request):
     """Return a value of the wrong type to represent a version number.
@@ -255,6 +262,56 @@ def std_ver_all_uninst_typeerr(request):
     return request.param
 
 
+@pytest.fixture(params=MINOR_MIXED_VER_INVALID + MAJOR_INVALID + iati.tests.utilities.generate_test_types(['int'], True))
+def std_ver_all_uninst_mixederr(request):
+    """Return a value that does not represent a version number."""
+    return request.param
+
+
+@pytest.fixture(params=[
+    ver.iativer_str for ver in iati.version.STANDARD_VERSIONS_MINOR
+] + [
+    ver.semver_str for ver in iati.version.STANDARD_VERSIONS_MINOR
+] + iati.version.STANDARD_VERSIONS_MINOR + [
+    iati.version.STANDARD_VERSION_ANY
+])
+def std_ver_minor_independent_mixedinst_valid_known(request):
+    """Return an IATI version number that pyIATI knows to exist, or independent.
+
+    Todo:
+        Add decimal representations where possible.
+
+    """
+    return request.param
+
+
+@pytest.fixture(params=[
+    ver.iativer_str for ver in iati.version.STANDARD_VERSIONS_MINOR
+] + [
+    ver.semver_str for ver in iati.version.STANDARD_VERSIONS_MINOR
+] + [
+    iati.version.STANDARD_VERSION_ANY
+] + iati.version.STANDARD_VERSIONS_MINOR + MAJOR_KNOWN)
+def std_ver_any_mixedinst_valid_known(request):
+    """Return a value that can represent some known version number at any level of granularity.
+
+    Todo:
+        Add decimal representations where possible.
+
+    """
+    return request.param
+
+
+@pytest.fixture(params=[
+    iati.Version(version) for version in MINOR_IATIVER_VALID if not iati.Version(version) in iati.version.STANDARD_VERSIONS_MINOR
+] + [
+    major_version for major_version in MAJOR_VALID if major_version not in MAJOR_KNOWN
+])
+def std_ver_all_mixedinst_valid_unknown(request):
+    """Return a major or minor version of the IATI Standard that is not known by pyIATI to exist."""
+    return request.param
+
+
 @pytest.fixture(params=MINOR_DECIMAL_VALID)
 def std_ver_minor_uninst_valid_decimal_possible(request):
     """Return a decimal value that is a valid representation of a minor version number."""
@@ -293,7 +350,7 @@ def std_ver_minor_uninst_valid_possible(request):
 
 @pytest.fixture(params=MINOR_MIXED_VER_INVALID)
 def std_ver_minor_uninst_valueerr_str_decimal(request):
-    """Return a valid version number in a valid format."""
+    """Return an invalid version number in a valid format."""
     return request.param
 
 
@@ -312,6 +369,21 @@ def std_ver_minor_uninst_valid_known(request):
     return request.param
 
 
+@pytest.fixture(params=[
+    ver.iativer_str for ver in iati.version.STANDARD_VERSIONS_MINOR
+] + [
+    ver.semver_str for ver in iati.version.STANDARD_VERSIONS_MINOR
+] + iati.version.STANDARD_VERSIONS_MINOR)
+def std_ver_minor_mixedinst_valid_known(request):
+    """Return an IATI version number that pyIATI knows to exist.
+
+    Todo:
+        Add decimal representations where possible.
+
+    """
+    return request.param
+
+
 @pytest.fixture(params=[
     ver.iativer_str for ver in iati.version.STANDARD_VERSIONS_SUPPORTED
 ] + [
@@ -370,7 +442,7 @@ def std_ver_minor_inst_valid_known(request):
     version for version in MINOR_IATIVER_VALID if not iati.Version(version) in iati.version.STANDARD_VERSIONS_MINOR
 ])
 def std_ver_minor_inst_valid_unknown(request):
-    """Return a version of the IATI Standard that is not known by pyIATI to exist."""
+    """Return a minor version of the IATI Standard that is not known by pyIATI to exist."""
     return iati.Version(request.param)