Merge pull request #6 from TaskarCenterAtUW/feature-extensions

Points are not required for a valid OSW dataset

Author: sureshgaussian

CHANGELOG.md

@@ -8,4 +8,7 @@
 - Updated README file
 
 ### 0.0.3
-- Added schema file to package
+- Added schema file to package
+
+### 0.0.4
+- Points are not required for a valid OSW dataset

README.md

@@ -11,8 +11,8 @@ This package validates the OSW geojson file. Package requires a OSW zip file pat
 ## What this package does?
 
 - It unzip the provided zip files
-- Check for nodes, edges and points geojson files inside the unzipped folder
-- Validate each file against schema, schema can be found here
+- Check for the required nodes and edges geojson files inside the unzipped folder
+- Validate each file (nodes, edges and points) against schema, schema can be found here
 - Return true or false according to validation
 - you can check the error if it returned false.
 
@@ -73,6 +73,9 @@ test_invalid_geometry_zipfile (test_osw_validation.TestOSWValidation) ... ok
 test_invalid_zipfile (test_osw_validation.TestOSWValidation) ... ok
 test_invalid_zipfile_with_invalid_schema (test_osw_validation.TestOSWValidation) ... ok
 test_invalid_zipfile_with_schema (test_osw_validation.TestOSWValidation) ... ok
+test_minimal_zipfile (test_osw_validation.TestOSWValidation) ... ok
+test_minimal_zipfile_with_invalid_schema (test_osw_validation.TestOSWValidation) ... ok
+test_minimal_zipfile_with_schema (test_osw_validation.TestOSWValidation) ... ok
 test_missing_files_inside_zipfile (test_osw_validation.TestOSWValidation) ... ok
 test_missing_files_inside_zipfile_with_invalid_schema (test_osw_validation.TestOSWValidation) ... ok
 test_missing_files_inside_zipfile_with_schema (test_osw_validation.TestOSWValidation) ... ok
@@ -93,7 +96,7 @@ test_extract_valid_zip (test_zipfile_handler.TestZipFileHandler) ... ok
 test_remove_extracted_files (test_zipfile_handler.TestZipFileHandler) ... ok
 
 ----------------------------------------------------------------------
-Ran 31 tests in 193.358s
+Ran 34 tests in 121.220s
 
 OK
 ```

freeze_version.py

@@ -11,7 +11,7 @@
 
 build_date = date.today().strftime('%Y-%m-%d')
 
-version = '0.0.3'
+version = '0.0.4'
 
 with open(version_file_path, 'w+') as version_file:
     version_file.write("version = '{}'\n".format(version))

src/python_osw_validation/extracted_data_validator.py

@@ -14,20 +14,24 @@ def is_valid(self) -> bool:
             return False
 
         geojson_files = glob.glob(os.path.join(self.extracted_dir, '*.geojson'))
-        if len(geojson_files) < 3:
+        if len(geojson_files) < 2:
             self.error = 'There are not enough .geojson files in the folder.'
             return False
 
+        edges_present = False
+        nodes_present = False
         for filename in geojson_files:
             base_name = os.path.basename(filename)
             if 'edges' in base_name and base_name.endswith('.geojson'):
                 self.files.append(filename)
+                edges_present = True
             elif 'nodes' in base_name and base_name.endswith('.geojson'):
                 self.files.append(filename)
+                nodes_present = True
             elif 'points' in base_name and base_name.endswith('.geojson'):
                 self.files.append(filename)
 
-        if len(self.files) != 3:
+        if not edges_present or not nodes_present:
             self.error = 'Missing one or more required .geojson files.'
             return False
 

tests/assets/minimal.zip

@@ -35,7 +35,7 @@ def create_invalid_missing_files_directory(self):
 
     def create_invalid_missing_required_files_directory(self):
         # Create a directory with three geojson files, but not all required ones
-        invalid_files = ['edges.geojson', 'invalid.geojson', 'nodes.geojson']
+        invalid_files = ['edges.geojson', 'invalid.geojson', 'points.geojson']
         for file in invalid_files:
             open(os.path.join(self.invalid_missing_required_files_dir, file), 'w').close()
 

tests/unit_tests/test_extracted_data_validator.py

@@ -14,6 +14,7 @@ class TestOSWValidation(unittest.TestCase):
 
     def setUp(self):
         self.valid_zipfile = os.path.join(ASSETS_PATH, 'valid.zip')
+        self.minimal_zipfile = os.path.join(ASSETS_PATH, 'minimal.zip')
         self.invalid_zipfile = os.path.join(ASSETS_PATH, 'invalid.zip')
         self.nodes_invalid_zipfile = os.path.join(ASSETS_PATH, 'nodes_invalid.zip')
         self.edges_invalid_zipfile = os.path.join(ASSETS_PATH, 'edges_invalid.zip')
@@ -46,6 +47,23 @@ def test_valid_zipfile_with_invalid_schema(self):
         result = validation.validate()
         self.assertTrue(len(result.errors) > 0)
 
+    def test_minimal_zipfile(self):
+        validation = OSWValidation(zipfile_path=self.minimal_zipfile)
+        result = validation.validate()
+        self.assertTrue(result.is_valid)
+        self.assertIsNone(result.errors)
+
+    def test_minimal_zipfile_with_schema(self):
+        validation = OSWValidation(zipfile_path=self.minimal_zipfile, schema_file_path=self.schema_file_path)
+        result = validation.validate()
+        self.assertTrue(result.is_valid)
+        self.assertIsNone(result.errors)
+
+    def test_minimal_zipfile_with_invalid_schema(self):
+        validation = OSWValidation(zipfile_path=self.minimal_zipfile, schema_file_path=self.invalid_schema_file_path)
+        result = validation.validate()
+        self.assertTrue(len(result.errors) > 0)
+
     def test_invalid_zipfile(self):
         validation = OSWValidation(zipfile_path=self.invalid_zipfile)
         result = validation.validate()