fix: use UI-resolved project path as project ID (#701)

* fix: use UI-resolved project path as project ID
* fix: removes the duplicate method from a bad merge

Author: rokroskar

renku/core/management/repository.py

@@ -133,45 +133,9 @@ def cwl_prefix(self):
         self.workflow_path.mkdir(parents=True, exist_ok=True)  # for Python 3.5
         return str(self.workflow_path.resolve().relative_to(self.path))
 
-    @property
-    def project_id(self):
-        """Return the id for the project based on the repo origin remote."""
-        from renku.core.models.git import GitURL
-
-        remote_name = 'origin'
-        try:
-            remote_branch = self.repo.head.reference.tracking_branch()
-            if remote_branch is not None:
-                remote_name = remote_branch.remote_name
-        except TypeError:
-            pass
-
-        try:
-            url = GitURL.parse(self.repo.remotes[remote_name].url)
-
-            # Remove gitlab. unless running on gitlab.com.
-            hostname_parts = url.hostname.split('.')
-            if len(hostname_parts) > 2 and hostname_parts[0] == 'gitlab':
-                hostname_parts = hostname_parts[1:]
-            url = attr.evolve(url, hostname='.'.join(hostname_parts))
-        except IndexError:
-            url = None
-
-        if url:
-            remote_url = 'https://' + url.hostname
-
-            if url.owner:
-                remote_url += '/' + url.owner
-            if url.name:
-                remote_url += '/' + url.name
-
-            return remote_url
-
-        return 'file://{0}'.format(self.path)
-
     @cached_property
     def project(self):
-        """Return the FOAF/PROV representation of the project."""
+        """Return the Project instance."""
         if self.renku_metadata_path.exists():
             return Project.from_yaml(self.renku_metadata_path, client=self)
 
@@ -365,16 +329,15 @@ def with_commit(self, commit):
                 self.repo.git.checkout(current_commit)
 
     @contextmanager
-    def with_metadata(self, read_only=False):
+    def with_metadata(self, read_only=False, name=None):
         """Yield an editable metadata object."""
         metadata_path = self.renku_metadata_path
 
         if metadata_path.exists():
             metadata = Project.from_yaml(metadata_path, client=self)
         else:
-            metadata = Project.from_jsonld({},
-                                           client=self,
-                                           __reference__=metadata_path)
+            metadata = Project(name=name, client=self)
+            metadata.__reference__ = metadata_path
 
         yield metadata
 
@@ -451,8 +414,7 @@ def init_repository(self, name=None, force=False):
                 ) + '\n'
             )
 
-        with self.with_metadata() as metadata:
-            metadata.name = name
+        with self.with_metadata(name=name) as metadata:
             metadata.updated = datetime.now(timezone.utc)
 
         return str(path)

renku/core/models/projects.py

@@ -18,6 +18,7 @@
 """Model objects representing projects."""
 
 import datetime
+import os
 
 import attr
 
@@ -26,6 +27,8 @@
 from renku.core.models.datastructures import Collection
 from renku.core.utils.datetime8601 import parse_date
 
+PROJECT_URL_PATH = 'projects'
+
 
 @jsonld.s(
     type=[
@@ -65,7 +68,14 @@ class Project(object):
 
     client = attr.ib(default=None, kw_only=True)
 
-    creator = jsonld.ib(default=None, kw_only=True, context='schema:creator')
+    creator = jsonld.ib(
+        default=None,
+        kw_only=True,
+        context={
+            '@id': 'schema:creator',
+            '@type': 'schema:Person',
+        },
+    )
 
     _id = jsonld.ib(context='@id', kw_only=True, default=None)
 
@@ -88,8 +98,32 @@ def __attrs_post_init__(self):
                 # this assumes the project is being newly created
                 self.creator = Creator.from_git(self.client.repo)
 
-        if not self._id and self.client:
-            self._id = self.client.project_id
+        self._id = self.project_id
+
+    @property
+    def project_id(self):
+        """Return the id for the project based on the repo origin remote."""
+        import pathlib
+        import urllib
+
+        # Determine the hostname for the resource URIs.
+        # If RENKU_DOMAIN is set, it overrides the host from remote.
+        # Default is localhost.
+        host = 'localhost'
+        owner = self.creator.email.split('@')[0] if self.creator else 'NULL'
+        name = self.name
+
+        if self.client:
+            remote = self.client.remote
+            host = self.client.remote.get('host') or host
+            owner = remote.get('owner') or owner
+            name = remote.get('name') or name
+        host = os.environ.get('RENKU_DOMAIN') or host
+        project_url = urllib.parse.urljoin(
+            'https://{host}'.format(host=host),
+            pathlib.posixpath.join(PROJECT_URL_PATH, owner, name or 'NULL')
+        )
+        return project_url
 
 
 class ProjectCollection(Collection):

tests/core/commands/test_projects.py tests/core/models/test_projects.pytests/core/commands/test_projects.py renamed to tests/core/models/test_projects.py

@@ -16,7 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """Test projects API."""
-
+import os
 from datetime import datetime, timezone
 
 import pytest
@@ -110,7 +110,8 @@ def test_project_serialization():
 
     context = data['@context']
     assert 'schema:name' == context['name']
-    assert 'schema:creator' == context['creator']
+    assert 'schema:creator' == context['creator'].get('@id')
+    assert 'schema:Person' == context['creator'].get('@type')
     assert 'schema:dateUpdated' == context['updated']
     assert 'schema:dateCreated' == context['created']
     assert 'schema:schemaVersion' == context['version']
@@ -135,7 +136,8 @@ def test_project_metadata_compatibility(project_meta, version, is_broken):
         assert 'demo' == project.name
 
     assert 'schema:name' == project._jsonld_context['name']
-    assert 'schema:creator' == project._jsonld_context['creator']
+    assert 'schema:creator' == project._jsonld_context['creator'].get('@id')
+    assert 'schema:Person' == project._jsonld_context['creator'].get('@type')
     assert 'schema:dateUpdated' == project._jsonld_context['updated']
     assert 'schema:dateCreated' == project._jsonld_context['created']
     assert 'schema:schemaVersion' == project._jsonld_context['version']
@@ -181,3 +183,46 @@ def test_project_creator_deserialization(client, project):
     # now the creator should be the one from the commit
     project = Project.from_yaml(client.renku_metadata_path, client=client)
     assert project.creator.email == '[email protected]'
+
+
+def test_project_uri(client, project, monkeypatch):
+    """Test that the project URI is correctly formed."""
+    from git.refs import RemoteReference
+    from git.refs.head import Head
+
+    # 1. the simple case where no other hostname exists
+    assert client.project._id.startswith('https://localhost')
+
+    # use the RENKU_DOMAIN environment variable to override localhost
+    with monkeypatch.context() as monkey:
+        monkey.setenv('RENKU_DOMAIN', 'renku.ch')
+        project = Project.from_yaml(client.renku_metadata_path, client=client)
+        assert project._id.startswith('https://renku.ch')
+
+    # 2. set up the master remote to be at https://example.com
+    # This should yield a project id that starts with https://example.com
+    host = 'example.com'
+    client.repo.git.remote(
+        'add', 'origin', 'https://{host}/namespace/{name}.git'.format(
+            host=host, name=client.project.name
+        )
+    )
+
+    def mock_tracking():
+        return RemoteReference('refs/remotes/origin/master')
+
+    with monkeypatch.context() as monkey:
+        monkey.setattr(Head, 'tracking_branch', mock_tracking)
+        project = Project.from_yaml(client.renku_metadata_path, client=client)
+        project_id = 'https://{host}/projects/namespace/{name}'.format(
+            host=host, name=client.project.name
+        )
+        assert project._id == project_id
+
+        # use the RENKU_DOMAIN environment variable to override remote
+        monkey.setenv('RENKU_DOMAIN', 'renku.ch')
+        project = Project.from_yaml(client.renku_metadata_path, client=client)
+        project_id = 'https://{host}/projects/namespace/{name}'.format(
+            host=os.environ.get('RENKU_DOMAIN'), name=client.project.name
+        )
+        assert project._id == project_id