import pathlib import pytest from pytest import raises from teal.db import MultipleResourcesFound, ResourceNotFound, UniqueViolation from teal.marshmallow import ValidationError from ereuse_devicehub.client import UserClient from ereuse_devicehub.db import db from ereuse_devicehub.devicehub import Devicehub from ereuse_devicehub.resources.agent.models import Organization from ereuse_devicehub.resources.device.models import Desktop, Device from ereuse_devicehub.resources.enums import ComputerChassis from ereuse_devicehub.resources.tag import Tag from ereuse_devicehub.resources.tag.view import CannotCreateETag, LinkedToAnotherDevice, \ TagNotLinked from tests import conftest @pytest.mark.usefixtures(conftest.app_context.__name__) def test_create_tag(): """Creates a tag specifying a custom organization.""" org = Organization(name='Bar', tax_id='BarTax') tag = Tag(id='bar-1', org=org) db.session.add(tag) db.session.commit() @pytest.mark.usefixtures(conftest.app_context.__name__) def test_create_tag_default_org(): """Creates a tag using the default organization.""" tag = Tag(id='foo-1') assert not tag.org_id, 'org-id is set as default value so it should only load on flush' # We don't want the organization to load, or it would make this # object, from transient to new (added to session) assert 'org' not in vars(tag), 'Organization should not have been loaded' db.session.add(tag) db.session.commit() assert tag.org.name == 'FooOrg' # as defined in the settings @pytest.mark.usefixtures(conftest.app_context.__name__) def test_create_tag_no_slash(): """Checks that no tags can be created that contain a slash.""" with raises(ValidationError): Tag('/') with raises(ValidationError): Tag('bar', secondary='/') @pytest.mark.usefixtures(conftest.app_context.__name__) def test_create_two_same_tags(): """Ensures there cannot be two tags with the same ID and organization.""" db.session.add(Tag(id='foo-bar')) db.session.add(Tag(id='foo-bar')) with raises(UniqueViolation): db.session.commit() db.session.rollback() # And it works if tags are in different organizations db.session.add(Tag(id='foo-bar')) org2 = Organization(name='org 2', tax_id='tax id org 2') db.session.add(Tag(id='foo-bar', org=org2)) db.session.commit() def test_tag_post(app: Devicehub, user: UserClient): """Checks the POST method of creating a tag.""" user.post({'id': 'foo'}, res=Tag) with app.app_context(): assert Tag.query.filter_by(id='foo').one() def test_tag_post_etag(user: UserClient): """ Ensures users cannot create eReuse.org tags through POST; only terminal. """ user.post({'id': 'FO-123456'}, res=Tag, status=CannotCreateETag) # Although similar, these are not eTags and should pass user.post({'id': 'FO-0123-45'}, res=Tag) user.post({'id': 'FOO012345678910'}, res=Tag) user.post({'id': 'FO'}, res=Tag) user.post({'id': 'FO-'}, res=Tag) user.post({'id': 'FO-123'}, res=Tag) user.post({'id': 'FOO-123456'}, res=Tag) def test_tag_get_device_from_tag_endpoint(app: Devicehub, user: UserClient): """Checks getting a linked device from a tag endpoint""" with app.app_context(): # Create a pc with a tag tag = Tag(id='foo-bar') pc = Desktop(serial_number='sn1', chassis=ComputerChassis.Tower) pc.tags.add(tag) db.session.add(pc) db.session.commit() computer, _ = user.get(res=Tag, item='foo-bar/device') assert computer['serialNumber'] == 'sn1' def test_tag_get_device_from_tag_endpoint_no_linked(app: Devicehub, user: UserClient): """As above, but when the tag is not linked.""" with app.app_context(): db.session.add(Tag(id='foo-bar')) db.session.commit() user.get(res=Tag, item='foo-bar/device', status=TagNotLinked) def test_tag_get_device_from_tag_endpoint_no_tag(user: UserClient): """As above, but when there is no tag with such ID.""" user.get(res=Tag, item='foo-bar/device', status=ResourceNotFound) def test_tag_get_device_from_tag_endpoint_multiple_tags(app: Devicehub, user: UserClient): """ As above, but when there are two tags with the same ID, the system should not return any of both (to be deterministic) so it should raise an exception. """ with app.app_context(): db.session.add(Tag(id='foo-bar')) org2 = Organization(name='org 2', tax_id='tax id org 2') db.session.add(Tag(id='foo-bar', org=org2)) db.session.commit() user.get(res=Tag, item='foo-bar/device', status=MultipleResourcesFound) def test_tag_create_tags_cli(app: Devicehub, user: UserClient): """Checks creating tags with the CLI endpoint.""" runner = app.test_cli_runner() runner.invoke(args=['create-tag', 'id1'], catch_exceptions=False) with app.app_context(): tag = Tag.query.one() # type: Tag assert tag.id == 'id1' assert tag.org.id == Organization.get_default_org_id() def test_tag_manual_link(app: Devicehub, user: UserClient): """Tests linking manually a tag through PUT /tags//device/""" with app.app_context(): db.session.add(Tag('foo-bar', secondary='foo-sec')) desktop = Desktop(serial_number='foo', chassis=ComputerChassis.AllInOne) db.session.add(desktop) db.session.commit() desktop_id = desktop.id user.put({}, res=Tag, item='foo-bar/device/{}'.format(desktop_id), status=204) device, _ = user.get(res=Device, item=1) assert device['tags'][0]['id'] == 'foo-bar' # Device already linked # Just returns an OK to conform to PUT as anything changes user.put({}, res=Tag, item='foo-sec/device/{}'.format(desktop_id), status=204) # cannot link to another device when already linked user.put({}, res=Tag, item='foo-bar/device/99', status=LinkedToAnotherDevice) @pytest.mark.usefixtures(conftest.app_context.__name__) def test_tag_secondary(): """Creates and consumes tags with a secondary id.""" t = Tag('foo', secondary='bar') db.session.add(t) db.session.flush() assert Tag.from_an_id('bar').one() == t assert Tag.from_an_id('foo').one() == t with pytest.raises(ResourceNotFound): Tag.from_an_id('nope').one() def test_tag_create_tags_cli_csv(app: Devicehub, user: UserClient): """Checks creating tags with the CLI endpoint using a CSV.""" csv = pathlib.Path(__file__).parent / 'files' / 'tags-cli.csv' runner = app.test_cli_runner() runner.invoke(args=['create-tags-csv', str(csv)], catch_exceptions=False) with app.app_context(): t1 = Tag.from_an_id('id1').one() t2 = Tag.from_an_id('sec1').one() assert t1 == t2 def test_tag_multiple_secondary_org(user: UserClient): """Ensures two secondary ids cannot be part of the same Org.""" user.post({'id': 'foo', 'secondary': 'bar'}, res=Tag) user.post({'id': 'foo1', 'secondary': 'bar'}, res=Tag, status=UniqueViolation)