refactor(endpoints/api/tag*): adding in new support for tags api

this creates an interface for hidding details of the data model for pre oci and post oci code

Issue: https://coreosdev.atlassian.net/browse/QUAY-632

- [ ] It works!
- [ ] Comments provide sufficient explanations for the next contributor
- [ ] Tests cover changes and corner cases
- [ ] Follows Quay syntax patterns and format

endpoints/api/tag.py

@@ -2,18 +2,38 @@
 
 from flask import request, abort
 
+from auth.auth_context import get_authenticated_user
+from data import model
 from endpoints.api import (
   resource, nickname, require_repo_read, require_repo_write, RepositoryParamResource, log_action,
   validate_json_request, path_param, parse_args, query_param, truthy_bool,
   disallow_for_app_repositories)
-from endpoints.exception import NotFound
 from endpoints.api.image import image_view
+from endpoints.api.tag_interface.models_pre_oci import pre_oci_model
+from endpoints.exception import NotFound
 from endpoints.v2.manifest import _generate_and_store_manifest
-from data import model
-from auth.auth_context import get_authenticated_user
 from util.names import TAG_ERROR, TAG_REGEX
 
 
+def tag_view(tag):
+  tag_info = {
+    'name': tag.name,
+    'docker_image_id': tag.docker_image_id,
+    'reversion': tag.reversion,
+  }
+
+  if tag.lifetime_start_ts > 0:
+    tag_info['start_ts'] = tag.lifetime_start_ts
+
+  if tag.lifetime_end_ts > 0:
+    tag_info['end_ts'] = tag.lifetime_end_ts
+
+  if tag.manifest_list:
+    tag_info['manifest_digest'] = tag.manifest_list
+
+  return tag_info
+
+
 @resource('/v1/repository/<apirepopath:repository>/tag/')
 @path_param('repository', 'The full path of the repository. e.g. namespace/name')
 class ListRepositoryTags(RepositoryParamResource):
@@ -28,39 +48,20 @@ class ListRepositoryTags(RepositoryParamResource):
   @query_param('page', 'Page index for the results. Default 1.', type=int, default=1)
   @nickname('listRepoTags')
   def get(self, namespace, repository, parsed_args):
-    repo = model.repository.get_repository(namespace, repository)
-    if not repo:
-      raise NotFound()
-
-    def tag_view(tag):
-      tag_info = {
-        'name': tag.name,
-        'docker_image_id': tag.image.docker_image_id,
-        'reversion': tag.reversion,
-      }
-
-      if tag.lifetime_start_ts > 0:
-        tag_info['start_ts'] = tag.lifetime_start_ts
-
-      if tag.lifetime_end_ts > 0:
-        tag_info['end_ts'] = tag.lifetime_end_ts
-
-      if tag.id in manifest_map:
-        tag_info['manifest_digest'] = manifest_map[tag.id]
-
-      return tag_info
-
     specific_tag = parsed_args.get('specificTag') or None
-
     page = max(1, parsed_args.get('page', 1))
     limit = min(100, max(1, parsed_args.get('limit', 50)))
-    tags, manifest_map, more = model.tag.list_repository_tag_history(repo, page=page, size=limit,
+
-                                                                     specific_tag=specific_tag)
+    tag_history = pre_oci_model.list_repository_tag_history(namespace_name=namespace, repository_name=repository,
+                                                            page=page, size=limit, specific_tag=specific_tag)
+
+    if not tag_history:
+      raise NotFound()
 
     return {
-      'tags': [tag_view(tag) for tag in tags],
+      'tags': [tag_view(tag) for tag in tag_history.tags],
       'page': page,
-      'has_additional': more,
+      'has_additional': tag_history.more,
     }
 
 

endpoints/api/tag_interface/models_interface.py

@@ -0,0 +1,39 @@
+from abc import ABCMeta, abstractmethod
+from collections import namedtuple
+
+from six import add_metaclass
+
+
+class Tag(namedtuple('Tag', ['name', 'image', 'reversion', 'lifetime_start_ts', 'lifetime_end_ts',
+                             'manifest_list', 'docker_image_id'])):
+  """
+  Tag represents a name to an image.
+  :type name: string
+  :type image: Image
+  :type reversion: boolean
+  :type lifetime_start_ts: int
+  :type lifetime_end_ts: int
+  :type manifest_list: [manifest_digest]
+  :type docker_image_id: string
+  """
+
+
+class RepositoryTagHistory(namedtuple('RepositoryTagHistory', ['tags', 'more'])):
+  """
+  Tag represents a name to an image.
+  :type tags: [Tag]
+  :type more: boolean
+  """
+
+
+@add_metaclass(ABCMeta)
+class TagDataInterface(object):
+  """
+  Interface that represents all data store interactions required by a Tag.
+  """
+
+  @abstractmethod
+  def list_repository_tag_history(self, namespace_name, repository_name, page=1, size=100, specific_tag=None):
+    """
+    Returns a RepositoryTagHistory with a list of historic tags and whether there are more tags then returned.
+    """

endpoints/api/tag_interface/models_pre_oci.py

@@ -0,0 +1,27 @@
+from data import model
+from endpoints.api.tag_interface.models_interface import TagDataInterface, Tag, RepositoryTagHistory
+
+
+class PreOCIModel(TagDataInterface):
+  """
+  PreOCIModel implements the data model for the Tags using a database schema
+  before it was changed to support the OCI specification.
+  """
+
+  def list_repository_tag_history(self, namespace_name, repository_name, page=1, size=100, specific_tag=None):
+    repository = model.repository.get_repository(namespace_name, repository_name)
+    if repository is None:
+      return None
+    tags, manifest_map, more = model.tag.list_repository_tag_history(repository, page, size, specific_tag)
+    repository_tag_history = []
+    for tag in tags:
+      manifest_list = None
+      if tag.id in manifest_map:
+        manifest_list = manifest_map[tag.id]
+      repository_tag_history.append(
+        Tag(name=tag.name, image=tag.image, reversion=tag.reversion, lifetime_start_ts=tag.lifetime_start_ts,
+            lifetime_end_ts=tag.lifetime_end_ts, manifest_list=manifest_list,
+            docker_image_id=tag.image.docker_image_id))
+    return RepositoryTagHistory(tags=repository_tag_history, more=more)
+
+pre_oci_model = PreOCIModel()

endpoints/api/tag_interface/test/test_models_pre_oci.py

@@ -0,0 +1,95 @@
+import pytest
+from data.model.tag_interface.models_interface import RepositoryTagHistory, Tag
+from mock import Mock
+
+from data import model
+from endpoints.api.tag_interface.models_pre_oci import pre_oci_model
+
+EMPTY_REPOSITORY = 'empty_repository'
+
+EMPTY_NAMESPACE = 'empty_namespace'
+
+BAD_REPOSITORY_NAME = 'bad_repository_name'
+
+BAD_NAMESPACE_NAME = 'bad_namespace_name'
+
+
+@pytest.fixture
+def get_monkeypatch(monkeypatch):
+  return monkeypatch
+
+
+def mock_out_get_repository(monkeypatch, namespace_name, repository_name):
+  def return_none(namespace_name, repository_name):
+    return None
+
+  def return_repository(namespace_name, repository_name):
+    return 'repository'
+
+  if namespace_name == BAD_NAMESPACE_NAME or repository_name == BAD_REPOSITORY_NAME:
+    return_function = return_none
+  else:
+    return_function = return_repository
+
+  monkeypatch.setattr(model.repository, 'get_repository', return_function)
+
+
+def create_mock_tag(name, reversion, lifetime_start_ts, lifetime_end_ts, mock_id, docker_image_id, manifest_list):
+  tag_mock = Mock()
+  tag_mock.name = name
+  image_mock = Mock()
+  image_mock.docker_image_id = docker_image_id
+  tag_mock.image = image_mock
+  tag_mock.reversion = reversion
+  tag_mock.lifetime_start_ts = lifetime_start_ts
+  tag_mock.lifetime_end_ts = lifetime_end_ts
+  tag_mock.id = mock_id
+  tag_mock.manifest_list = manifest_list
+  tag = Tag(name=name, reversion=reversion, image=image_mock, docker_image_id=docker_image_id,
+            lifetime_start_ts=lifetime_start_ts, lifetime_end_ts=lifetime_end_ts, manifest_list=manifest_list)
+  return tag_mock, tag
+
+
+first_mock, first_tag = create_mock_tag('tag1', 'rev1', 'start1', 'end1', 'id1', 'docker_image_id1', [])
+second_mock, second_tag = create_mock_tag('tag2', 'rev2', 'start2', 'end2', 'id2', 'docker_image_id2', ['manifest'])
+
+
+def mock_out_list_repository_tag_history(monkeypatch, namespace_name, repository_name, page, size, specific_tag):
+  def list_empty_tag_history(repository, page, size, specific_tag):
+    return [], {}, False
+
+  def list_filled_tag_history(repository, page, size, specific_tag):
+    tags = [first_mock, second_mock]
+    return tags, {first_mock.id: first_mock.manifest_list,
+                  second_mock.id: second_mock.manifest_list}, len(tags) > size
+
+  def list_only_second_tag(repository, page, size, specific_tag):
+    tags = [second_mock]
+    return tags, {second_mock.id: second_mock.manifest_list}, len(tags) > size
+
+  if namespace_name == EMPTY_NAMESPACE or repository_name == EMPTY_REPOSITORY:
+    return_function = list_empty_tag_history
+  else:
+    if specific_tag == 'tag2':
+      return_function = list_only_second_tag
+    else:
+      return_function = list_filled_tag_history
+
+  monkeypatch.setattr(model.tag, 'list_repository_tag_history', return_function)
+
+
+@pytest.mark.parametrize(
+  'expected, namespace_name,        repository_name,       page,  size, specific_tag',
+  [(None, BAD_NAMESPACE_NAME, 'repository_name', 1, 100, None),
+   (None, 'namespace_name', BAD_REPOSITORY_NAME, 1, 100, None),
+   (RepositoryTagHistory(tags=[], more=False), EMPTY_NAMESPACE, EMPTY_REPOSITORY, 1, 100, None),
+   (RepositoryTagHistory(tags=[first_tag, second_tag], more=False), 'namespace', 'repository', 1, 100, None),
+   (RepositoryTagHistory(tags=[first_tag, second_tag], more=True), 'namespace', 'repository', 1, 1, None),
+   (RepositoryTagHistory(tags=[second_tag], more=False), 'namespace', 'repository', 1, 100, 'tag2'),
+   ])
+def test_list_repository_tag_history(expected, namespace_name, repository_name,
+                                     page, size, specific_tag, get_monkeypatch):
+  mock_out_get_repository(get_monkeypatch, namespace_name, repository_name)
+  mock_out_list_repository_tag_history(get_monkeypatch, namespace_name, repository_name, page, size, specific_tag)
+  assert pre_oci_model.list_repository_tag_history(namespace_name, repository_name, page, size,
+                                                   specific_tag) == expected