added project status function (closes #24)

Author: varmar05

README.md

@@ -22,7 +22,6 @@ For running test do:
     export TEST_MERGIN_URL=<url> # testing server
     export TEST_API_USERNAME=<username>
     export TEST_API_PASSWORD=<pwd>
-    export GEODIFFLIB=<path to libgeodiff.so>  # usually in mergin/deps/
     pipenv run pytest --cov-report html --cov=mergin test/
 
 

cli.py

@@ -117,50 +117,16 @@ def status():
 
     try:
         mp = MerginProject(os.getcwd())
-        project_info = mp.metadata
     except InvalidProject:
         click.secho('Invalid project directory', fg='red')
         return
 
-    project_name = project_info["name"]
     c = _init_client()
-
-    local_version = num_version(project_info["version"])
-
-    try:
-        versions = c.project_versions(project_name)
-    except Exception as e:
-        click.secho(str(e), fg='red')
-        return
-
-    click.echo("Current version: {}".format(project_info["version"]))
-    new_versions = [v for v in versions if num_version(v["name"]) > local_version]
-    if new_versions:
-        click.secho("### Available updates: {}".format(len(new_versions)), fg="magenta")
-
-        # TODO: insufficient API, files could be included in versions,
-        # or we should be able to request project_info at specific version
-        server_files = c.project_info(project_name, since=local_version)["files"]
-
-        # changes between current files and last version on server
-        # changes = project_changes(local_files, server_files)
-
-        # changes between versions on server
-        changes = mp.get_pull_changes(server_files)
-
-        click.echo()
-        click.secho("### Changes:", fg="magenta")
-        pretty_diff(changes)
-        click.echo()
-
-    changes = mp.get_push_changes()
-    changes_count = get_changes_count(changes)
-    if changes_count:
-        click.secho("### Local changes: {}".format(changes_count), fg="magenta")
-        pretty_diff(changes)
-    else:
-        click.secho("No local changes!", fg="magenta")
-    # TODO: show conflicts
+    pull_changes, push_changes = c.project_status(os.getcwd())
+    click.secho("### Server changes:", fg="magenta")
+    pretty_diff(pull_changes)
+    click.secho("### Local changes:", fg="magenta")
+    pretty_diff(push_changes)
 
 
 @cli.command()

mergin/client.py

@@ -1043,3 +1043,20 @@ def upload_chunk(chunk_id, data):
                 for chunk in file_meta["chunks"]:
                     data = file.read(UPLOAD_CHUNK_SIZE)
                     upload_chunk(chunk, data)
+
+    def project_status(self, directory):
+        """
+        Get project status, e.g. server and local changes.
+
+        :param directory: Project's directory
+        :type directory: String
+        :returns: changes metadata for files modified on server, and for those modified locally
+        :rtype: dict, dict
+        """
+        mp = MerginProject(directory)
+        project_path = mp.metadata["name"]
+        local_version = mp.metadata["version"]
+        server_info = self.project_info(project_path, since=local_version)
+        pull_changes = mp.get_pull_changes(server_info["files"])
+        push_changes = mp.get_push_changes()
+        return pull_changes, push_changes

mergin/test/test_client.py

@@ -129,6 +129,14 @@ def test_push_pull_changes(mc, parallel):
     with open(os.path.join(project_dir, f_updated), 'w') as f:
         f.write('Modified')
 
+    # check changes before applied
+    pull_changes, push_changes = mc.project_status(project_dir)
+    assert not sum(len(v) for v in pull_changes.values())
+    assert next((f for f in push_changes['added'] if f['path'] == f_added), None)
+    assert next((f for f in push_changes['removed'] if f['path'] == f_removed), None)
+    assert next((f for f in push_changes['updated'] if f['path'] == f_updated), None)
+    assert next((f for f in push_changes['renamed'] if f['path'] == f_renamed), None)
+
     mc.push_project(project_dir, parallel=parallel)
     project_info = mc.project_info(project)
     assert project_info['version'] == 'v2'
@@ -154,6 +162,14 @@ def test_push_pull_changes(mc, parallel):
     with pytest.raises(ClientError, match='Update your local repository'):
         mc.push_project(project_dir_2)
 
+    # check changes in project_dir_2 before applied
+    pull_changes, push_changes = mc.project_status(project_dir_2)
+    assert next((f for f in pull_changes['added'] if f['path'] == f_added), None)
+    assert next((f for f in pull_changes['removed'] if f['path'] == f_removed), None)
+    assert next((f for f in pull_changes['updated'] if f['path'] == f_updated), None)
+    assert next((f for f in pull_changes['renamed'] if f['path'] == f_renamed), None)
+    assert next((f for f in push_changes['updated'] if f['path'] == f_updated), None)
+
     mc.pull_project(project_dir_2, parallel=parallel)
     assert os.path.exists(os.path.join(project_dir_2, f_added))
     assert not os.path.exists(os.path.join(project_dir_2, f_removed))
@@ -222,7 +238,6 @@ def toggle_geodiff(enabled):
     # step 1) base.gpkg updated to inserted_1_A (inserted A feature)
     if push_geodiff_enabled:
         shutil.move(mp.fpath(f_updated), mp.fpath_meta(f_updated))  # make local copy for changeset calculation
-        pass
     shutil.copy(mp.fpath('inserted_1_A.gpkg'), mp.fpath(f_updated))
     mc.push_project(project_dir)
     if push_geodiff_enabled: