diff --git a/doc/source/developer/docker.rst b/doc/source/developer/docker.rst index a097fa9f5..af8faa40d 100644 --- a/doc/source/developer/docker.rst +++ b/doc/source/developer/docker.rst @@ -11,7 +11,7 @@ Labels are defined with the prefix namespace:: eu.simphony-project.docker -The following labels are currently defined. +The following labels are currently defined. Their definition can be found in ``remoteappmanager.docker.docker_labels`` - ``ui_name``: the UI visible name of the image @@ -21,12 +21,12 @@ Their definition can be found in ``remoteappmanager.docker.docker_labels`` the original base image (vncapp or webapp) - ``env``: subnamespace for accepted environment variables. See below. -The env is a subnamespace defining the environment variables the image internals +The env is a subnamespace defining the environment variables the image internals can understand. This does not mean that they are the only ones that will be -passed to the image. +passed to the image. -The naming strategy works around the `docker label restrictions -`_ +The naming strategy works around the `docker label restrictions +`_ of having `kebab case `_ vs envvars that are traditionally MACRO_CASE. Additionally, it allows new variables to be added by layers without having to know the variables understood by the base layer. @@ -39,7 +39,7 @@ and dashes converted to underscores. For example: the value of the label is currently unused, and should be left empty. If your application uses variables with a different convention, or uses double underscores, -you will have to define an auxilliary variable and transfer the value in the image +you will have to define an auxilliary variable and transfer the value in the image startup scripts. Currently reserved env keys: @@ -47,15 +47,17 @@ Currently reserved env keys: - ``x11-width``: for the VNC images, the X11 width - ``x11-height``: for the VNC images, the X11 height - ``x11-depth``: for the VNC images, the X11 depth (currently unused, fixed at 16) + - ``srdata``: this variable can be set to a file that will be loaded by an application + upon startup Container Labels '''''''''''''''' When a container is started, the following labels will be added: - - ``url_id``: unique identifier that ends up in the URL when the + - ``url_id``: unique identifier that ends up in the URL when the user is redirected - - ``mapping_id``: a unique key identifying the combination of image + - ``mapping_id``: a unique key identifying the combination of image and policy used to start the container. - ``user``: the user that started the container diff --git a/frontend/admin/vue-components/AccountingView.vue b/frontend/admin/vue-components/AccountingView.vue index d1bb95fbb..ae6ea82f1 100644 --- a/frontend/admin/vue-components/AccountingView.vue +++ b/frontend/admin/vue-components/AccountingView.vue @@ -99,7 +99,8 @@ item.allow_home, item.volume_source, item.volume_target, - item.volume_mode === "ro" + item.volume_mode === "ro", + item.allow_startup_data ]); }); }) diff --git a/frontend/admin/vue-components/accounting/NewAccountingDialog.vue b/frontend/admin/vue-components/accounting/NewAccountingDialog.vue index 4090f712f..07277272a 100644 --- a/frontend/admin/vue-components/accounting/NewAccountingDialog.vue +++ b/frontend/admin/vue-components/accounting/NewAccountingDialog.vue @@ -52,6 +52,12 @@ +
+ +
+

Both Volume Source and Target must be defined

@@ -83,7 +89,8 @@ volume_source: '', volume_target: '', volume_readonly: false, - volume_source_target: [] + volume_source_target: [], + allow_startup_data: false }, imageNames: [] }; @@ -136,7 +143,8 @@ allow_home: this.model.allow_home, volume_source: this.model.volume_source, volume_target: this.model.volume_target, - volume_mode: (model.volume_readonly ? "ro" : "rw") + volume_mode: (model.volume_readonly ? "ro" : "rw"), + allow_startup_data: this.model.allow_startup_data }; resources.Accounting.create(rep) diff --git a/frontend/user/configurables/StartupData.vue b/frontend/user/configurables/StartupData.vue new file mode 100644 index 000000000..274d330cc --- /dev/null +++ b/frontend/user/configurables/StartupData.vue @@ -0,0 +1,26 @@ + + + diff --git a/frontend/user/configurables/configurables.js b/frontend/user/configurables/configurables.js index 348ed97c4..2e27a3f96 100644 --- a/frontend/user/configurables/configurables.js +++ b/frontend/user/configurables/configurables.js @@ -1,6 +1,7 @@ let utils = require("utils"); require("./Resolution"); +require("./StartupData"); // Your configurable class must implement a tag and default configDict @@ -22,9 +23,23 @@ class ResolutionModel { } } +class StartupDataModel { + constructor() { + this.tag = "startupdata"; + this.configDict = { startupdata: '' }; + } + + asConfigDict() { + let startupdata = this.configDict.startupdata; + + return { startupdata: startupdata }; + } +} + let outputConfigurables = {}; // Export all your configurable models here respecting the tag (here resolution) outputConfigurables.resolution = ResolutionModel; +outputConfigurables.startupdata = StartupDataModel; module.exports = outputConfigurables; diff --git a/frontend/user/vue-components/ApplicationView.vue b/frontend/user/vue-components/ApplicationView.vue index a578de9da..1477e7c89 100644 --- a/frontend/user/vue-components/ApplicationView.vue +++ b/frontend/user/vue-components/ApplicationView.vue @@ -42,10 +42,18 @@
No configurable options for this image
- +
+ +
+
+ +
diff --git a/remoteappmanager/cli/remoteappdb/__main__.py b/remoteappmanager/cli/remoteappdb/__main__.py index f0fecaf88..e67c4b787 100644 --- a/remoteappmanager/cli/remoteappdb/__main__.py +++ b/remoteappmanager/cli/remoteappdb/__main__.py @@ -223,7 +223,8 @@ def list(ctx, no_decoration, show_apps): headers = ["ID", "Name"] if show_apps: headers += ["App", "License", "Home", "View", "Common", - "Vol. Source", "Vol. Target", "Vol. Mode"] + "Vol. Source", "Vol. Target", "Vol. Mode", + "Allow Startup Data"] session = ctx.obj.session @@ -240,7 +241,8 @@ def list(ctx, no_decoration, show_apps): entry.application_policy.allow_common, entry.application_policy.volume_source, entry.application_policy.volume_target, - entry.application_policy.volume_mode] + entry.application_policy.volume_mode, + entry.application_policy.allow_startup_data] for entry in orm.accounting_for_user(session, user)] if len(apps) == 0: @@ -352,8 +354,13 @@ def list(ctx, no_decoration): @click.option("--volume", type=click.STRING, help="Application data volume, format=SOURCE:TARGET:MODE, " "where mode is 'ro' or 'rw'.") +@click.option("--allow-startup-data", + is_flag=True, + help="Allow user to provide a file for the container to load" + "at startup.") @click.pass_context -def grant(ctx, image, user, app_license, allow_home, allow_view, volume): +def grant(ctx, image, user, app_license, allow_home, allow_view, volume, + allow_startup_data): """Grants access to application identified by IMAGE to a specific user USER and specified access policy.""" allow_common = False @@ -389,7 +396,9 @@ def grant(ctx, image, user, app_license, allow_home, allow_view, volume): orm.ApplicationPolicy.allow_view == allow_view, orm.ApplicationPolicy.volume_source == source, orm.ApplicationPolicy.volume_target == target, - orm.ApplicationPolicy.volume_mode == mode).one_or_none() + orm.ApplicationPolicy.volume_mode == mode, + orm.ApplicationPolicy.allow_startup_data == allow_startup_data + ).one_or_none() if orm_policy is None: orm_policy = orm.ApplicationPolicy( @@ -400,6 +409,7 @@ def grant(ctx, image, user, app_license, allow_home, allow_view, volume): volume_source=source, volume_target=target, volume_mode=mode, + allow_startup_data=allow_startup_data, ) session.add(orm_policy) @@ -440,10 +450,14 @@ def grant(ctx, image, user, app_license, allow_home, allow_view, volume): @click.option("--volume", type=click.STRING, help="Application data volume, format=SOURCE:TARGET:MODE, " "where mode is 'ro' or 'rw'.") +@click.option("--allow-startup-data", + is_flag=True, + help="Allow user to provide a file for the container to load" + "at startup.") @click.pass_context def revoke( ctx, image, user, revoke_all, app_license, - allow_home, allow_view, volume): + allow_home, allow_view, volume, allow_startup_data): """Revokes access to application identified by IMAGE to a specific user USER and specified parameters.""" allow_common = False @@ -478,7 +492,9 @@ def revoke( orm.ApplicationPolicy.allow_view == allow_view, orm.ApplicationPolicy.volume_source == source, orm.ApplicationPolicy.volume_target == target, - orm.ApplicationPolicy.volume_mode == mode).one() + orm.ApplicationPolicy.volume_mode == mode, + orm.ApplicationPolicy.allow_startup_data == allow_startup_data + ).one() session.query(orm.Accounting).filter( orm.Accounting.application == orm_app, diff --git a/remoteappmanager/cli/tests/test_remoteappdb.py b/remoteappmanager/cli/tests/test_remoteappdb.py index 68aaca4d7..0743f8d82 100644 --- a/remoteappmanager/cli/tests/test_remoteappdb.py +++ b/remoteappmanager/cli/tests/test_remoteappdb.py @@ -102,12 +102,14 @@ def test_app_grant(self): self._remoteappdb("app grant myapp user") self._remoteappdb("app grant myapp user " "--allow-view " - "--volume=frobniz:froble:ro") + "--volume=frobniz:froble:ro " + "--allow-startup-data") _, out = self._remoteappdb("user list --show-apps") self.assertIn("myapp", out) self.assertIn("frobniz", out) self.assertIn("froble", out) - self.assertIn(" ro\n", out) + self.assertIn(" ro", out) + self.assertIn("1\n", out) def test_app_revoke(self): self._remoteappdb("app create myapp --no-verify") diff --git a/remoteappmanager/db/csv_db.py b/remoteappmanager/db/csv_db.py index 6531ba913..7aca8d451 100644 --- a/remoteappmanager/db/csv_db.py +++ b/remoteappmanager/db/csv_db.py @@ -85,7 +85,8 @@ def __init__(self, id, name): 'policy.allow_common', 'policy.volume_source', 'policy.volume_target', - 'policy.volume_mode') + 'policy.volume_mode', + 'policy.allow_startup_data') @mergedocs(ABCDatabase) @@ -158,6 +159,9 @@ def __init__(self, csv_file_path, **kwargs): None) volume_mode = (record[indices['policy.volume_mode']] or None) + allow_startup_data = record[ + indices['policy.allow_startup_data'] + ] == '1' application_policy = self.application_policies.setdefault( (app_license, @@ -166,7 +170,8 @@ def __init__(self, csv_file_path, **kwargs): allow_common, volume_source, volume_target, - volume_mode), + volume_mode, + allow_startup_data), CSVApplicationPolicy( app_license=app_license, allow_home=allow_home, @@ -174,7 +179,8 @@ def __init__(self, csv_file_path, **kwargs): allow_common=allow_common, volume_source=volume_source, volume_target=volume_target, - volume_mode=volume_mode)) + volume_mode=volume_mode, + allow_startup_data=allow_startup_data)) # Save the configuration # Note that we don't filter existing duplicate entry @@ -222,11 +228,11 @@ def list_applications(self): return list(self.applications.values()) def grant_access(self, app_name, user_name, app_license, - allow_home, allow_view, volume): + allow_home, allow_view, volume, allow_startup_data): raise UnsupportedOperation() def revoke_access(self, app_name, user_name, app_license, - allow_home, allow_view, volume): + allow_home, allow_view, volume, allow_startup_data): raise UnsupportedOperation() def revoke_access_by_id(self, mapping_id): diff --git a/remoteappmanager/db/interfaces.py b/remoteappmanager/db/interfaces.py index 417df1569..b1e3471a5 100644 --- a/remoteappmanager/db/interfaces.py +++ b/remoteappmanager/db/interfaces.py @@ -27,7 +27,7 @@ class ABCApplicationPolicy(metaclass=ABCMeta): def __init__(self, app_license=None, allow_home=False, allow_view=False, allow_common=False, volume_source=None, volume_target=None, - volume_mode=None): + volume_mode=None, allow_startup_data=False): #: Application License (if specified) self.app_license = app_license @@ -50,6 +50,9 @@ def __init__(self, app_license=None, allow_home=False, allow_view=False, #: Mode for read-write access (ro = Read-only. rw = Read-write) self.volume_mode = volume_mode + #: Allow user to provide a file for the container to load at startup + self.allow_startup_data = allow_startup_data + def __repr__(self): args = _inspect.getargs( ABCApplicationPolicy.__init__.__code__).args[1:] @@ -203,7 +206,7 @@ def list_applications(self): @abstractmethod def grant_access(self, app_name, user_name, app_license, - allow_home, allow_view, volume): + allow_home, allow_view, volume, allow_startup_data): """Grant access for user to application. Parameters @@ -228,6 +231,9 @@ def grant_access(self, app_name, user_name, app_license, mode being "ro" or "rw". (e.g. "/host/path:/container/path:ro"). + allow_startup_data : bool + If the user can provide a file for the container to load at startup + Raises ------ exception.NotFound: @@ -243,7 +249,7 @@ def grant_access(self, app_name, user_name, app_license, @abstractmethod def revoke_access(self, app_name, user_name, app_license, - allow_home, allow_view, volume): + allow_home, allow_view, volume, allow_startup_data): """Revoke access for user to application. Parameters @@ -268,6 +274,9 @@ def revoke_access(self, app_name, user_name, app_license, mode being "ro" or "rw". (e.g. "/host/path:/container/path:ro"). + allow_startup_data : bool + If the user can provide a file for the container to load at startup + Raises ------ exception.NotFound: diff --git a/remoteappmanager/db/orm.py b/remoteappmanager/db/orm.py index 3c30b5f5b..7e9e8bc21 100644 --- a/remoteappmanager/db/orm.py +++ b/remoteappmanager/db/orm.py @@ -67,15 +67,18 @@ class ApplicationPolicy(IdMixin, Base): #: If the container should be accessible by other people allow_view = Column(Boolean) - # Which volume to mount + #: Which volume to mount volume_source = Column(Unicode, nullable=True) - # Where to mount it in the container + #: Where to mount it in the container volume_target = Column(Unicode, nullable=True) - # In which mode + #: In which mode volume_mode = Column(Enum("ro", "rw"), nullable=True) + #: If the user can open a file at startup + allow_startup_data = Column(Boolean) + class Accounting(Base): """Holds the information about who is allowed to run what.""" @@ -308,7 +311,7 @@ def list_applications(self): return applications def grant_access(self, app_name, user_name, app_license, - allow_home, allow_view, volume): + allow_home, allow_view, volume, allow_startup_data): allow_common = False source = target = mode = None @@ -334,7 +337,9 @@ def grant_access(self, app_name, user_name, app_license, ApplicationPolicy.allow_view == allow_view, ApplicationPolicy.volume_source == source, ApplicationPolicy.volume_target == target, - ApplicationPolicy.volume_mode == mode).one_or_none() + ApplicationPolicy.volume_mode == mode, + ApplicationPolicy.allow_startup_data == allow_startup_data + ).one_or_none() if orm_policy is None: orm_policy = ApplicationPolicy( @@ -345,6 +350,7 @@ def grant_access(self, app_name, user_name, app_license, volume_source=source, volume_target=target, volume_mode=mode, + allow_startup_data=allow_startup_data, ) session.add(orm_policy) @@ -372,7 +378,7 @@ def grant_access(self, app_name, user_name, app_license, return id def revoke_access(self, app_name, user_name, app_license, - allow_home, allow_view, volume): + allow_home, allow_view, volume, allow_startup_data): allow_common = False source = target = mode = None @@ -396,7 +402,9 @@ def revoke_access(self, app_name, user_name, app_license, ApplicationPolicy.allow_view == allow_view, ApplicationPolicy.volume_source == source, ApplicationPolicy.volume_target == target, - ApplicationPolicy.volume_mode == mode).one() + ApplicationPolicy.volume_mode == mode, + ApplicationPolicy.allow_startup_data == allow_startup_data + ).one() except NoResultFound: raise exceptions.NotFound() diff --git a/remoteappmanager/db/tests/abc_test_interfaces.py b/remoteappmanager/db/tests/abc_test_interfaces.py index f7fa45ec7..84155c4f9 100644 --- a/remoteappmanager/db/tests/abc_test_interfaces.py +++ b/remoteappmanager/db/tests/abc_test_interfaces.py @@ -145,7 +145,7 @@ def test_unsupported_ops(self): for method in [db.grant_access, db.revoke_access]: with self.assertRaises(exceptions.UnsupportedOperation): - method("bonkers", "uuu", 'key', True, False, "/a:/b:ro") + method("bonkers", "uuu", 'key', True, False, "/a:/b:ro", False) with self.assertRaises(exceptions.UnsupportedOperation): db.revoke_access_by_id(12345) diff --git a/remoteappmanager/db/tests/test_csv_db.py b/remoteappmanager/db/tests/test_csv_db.py index 0450dd51d..fa23eb72a 100644 --- a/remoteappmanager/db/tests/test_csv_db.py +++ b/remoteappmanager/db/tests/test_csv_db.py @@ -13,26 +13,26 @@ class GoodTable: 'policy.allow_home', 'policy.allow_view', 'policy.allow_common', 'policy.volume_source', 'policy.volume_target', - 'policy.volume_mode') + 'policy.volume_mode', 'policy.allow_startup_data') - # name, image, home, view, common, source, target, mode + # name, image, home, view, common, source, target, mode, startup_data records = [ - ('markdoe', 'simphonyproject/simphony-mayavi:0.6.0', '', '1', '1', '0', '', '', ''), # noqa - ('markdoe', 'simphonyproject/ubuntu-image:latest', '', '1', '1', '1', '/src', '/target', 'ro'), # noqa - ('johndoe', 'simphonyproject/simphony-mayavi:0.6.0', '', '0', '0', '0', '/src', '/target', 'ro')] # noqa + ('markdoe', 'simphonyproject/simphony-mayavi:0.6.0', '', '1', '1', '0', '', '', '', '0'), # noqa + ('markdoe', 'simphonyproject/ubuntu-image:latest', '', '1', '1', '1', '/src', '/target', 'ro', '0'), # noqa + ('johndoe', 'simphonyproject/simphony-mayavi:0.6.0', '', '0', '0', '0', '/src', '/target', 'ro', '0')] # noqa class BadTableMissingHeaders: # policy.volume_source and policy.volume_target are missing headers = ('user.name', 'application.image', 'policy.allow_home', 'policy.allow_view', 'policy.allow_common', - 'policy.volume_mode') + 'policy.volume_mode', 'policy.allow_startup_data') # name, image, home, view, common, mode records = [ - ('markdoe', 'simphonyproject/simphony-mayavi:0.6.0', '1', '1', '0', ''), # noqa - ('markdoe', 'simphonyproject/ubuntu-image:latest', '1', '1', '1', 'ro'), # noqa - ('johndoe', 'simphonyproject/simphony-mayavi:0.6.0', '0', '0', '0', 'ro')] # noqa + ('markdoe', 'simphonyproject/simphony-mayavi:0.6.0', '1', '1', '0', '', '0'), # noqa + ('markdoe', 'simphonyproject/ubuntu-image:latest', '1', '1', '1', 'ro', '0'), # noqa + ('johndoe', 'simphonyproject/simphony-mayavi:0.6.0', '0', '0', '0', 'ro', '0')] # noqa class GoodTableWithDifferentHeaders: @@ -43,13 +43,13 @@ class GoodTableWithDifferentHeaders: 'policy.volume_source', 'policy.volume_target', 'policy.volume_mode', 'user.name', 'application.image', 'policy.allow_home', - 'extra_column') + 'policy.allow_startup_data', 'extra_column') # view, common, source, target, mode, name, image, home, extra records = [ ('', '1', '0', '', '', '', 'markdoe', 'simphonyproject/simphony-mayavi:0.6.0', '1', 'anything'), # noqa - ('', '1', '1', '/src', '/target', 'ro', 'markdoe', 'simphonyproject/ubuntu-image:latest', '1', 'extra'), # noqa - ('', '0', '0', '/src', '/target', 'ro', 'johndoe', 'simphonyproject/simphony-mayavi:0.6.0', '0', 'abc')] # noqa + ('', '1', '1', '/src', '/target', 'ro', '0', 'markdoe', 'simphonyproject/ubuntu-image:latest', '1', '0', 'extra'), # noqa + ('', '0', '0', '/src', '/target', 'ro', 'johndoe', 'simphonyproject/simphony-mayavi:0.6.0', '0', '0', 'abc')] # noqa def write_csv_file(file_name, headers, records): @@ -85,14 +85,16 @@ def create_expected_configs(self, user): allow_common=False, volume_source=None, volume_target=None, - volume_mode=None)), + volume_mode=None, + allow_startup_data=False)), (CSVApplication(id=1, image='simphonyproject/ubuntu-image:latest'), # noqa CSVApplicationPolicy(allow_home=True, allow_view=True, allow_common=True, volume_source='/src', volume_target='/target', - volume_mode='ro')) + volume_mode='ro', + allow_startup_data=False)) ), 'johndoe': ( (CSVApplication(id=0, image='simphonyproject/simphony-mayavi:0.6.0'), # noqa @@ -101,7 +103,8 @@ def create_expected_configs(self, user): allow_common=False, volume_source='/src', volume_target='/target', - volume_mode='ro')), + volume_mode='ro', + allow_startup_data=False)), )} return mappings[user.name] diff --git a/remoteappmanager/db/tests/test_interfaces.py b/remoteappmanager/db/tests/test_interfaces.py index 483f06a6d..df92f1d6c 100644 --- a/remoteappmanager/db/tests/test_interfaces.py +++ b/remoteappmanager/db/tests/test_interfaces.py @@ -73,11 +73,11 @@ def list_applications(self): ] def grant_access(self, app_name, user_name, app_license, - allow_home, allow_view, volume): + allow_home, allow_view, volume, allow_startup_data): raise exceptions.UnsupportedOperation() def revoke_access(self, app_name, user_name, app_license, - allow_home, allow_view, volume): + allow_home, allow_view, volume, allow_startup_data): raise exceptions.UnsupportedOperation() def revoke_access_by_id(self, mapping_id): diff --git a/remoteappmanager/db/tests/test_orm.py b/remoteappmanager/db/tests/test_orm.py index 433894003..baea7de38 100644 --- a/remoteappmanager/db/tests/test_orm.py +++ b/remoteappmanager/db/tests/test_orm.py @@ -324,19 +324,19 @@ def test_grant_revoke_access(self): with self.assertRaises(exceptions.NotFound): database.grant_access( "simphonyremote/amazing", "ciccio", '', - True, False, "/foo:/bar:ro") + True, False, "/foo:/bar:ro", False) database.create_user("ciccio") with self.assertRaises(exceptions.NotFound): database.grant_access( "simphonyremote/amazing", "ciccio", '', - True, False, "/foo:/bar:ro") + True, False, "/foo:/bar:ro", False) database.create_application("simphonyremote/amazing") id = database.grant_access( "simphonyremote/amazing", "ciccio", 'some_key', - True, False, "/foo:/bar:ro") + True, False, "/foo:/bar:ro", False) self.assertIsNotNone(id) user = database.get_user(user_name="ciccio") @@ -349,23 +349,24 @@ def test_grant_revoke_access(self): self.assertEqual(acc[0].application_policy.volume_source, "/foo") self.assertEqual(acc[0].application_policy.volume_target, "/bar") self.assertEqual(acc[0].application_policy.volume_mode, "ro") + self.assertEqual(acc[0].application_policy.allow_startup_data, False) # Do it twice to check idempotency id2 = database.grant_access( "simphonyremote/amazing", "ciccio", 'some_key', - True, False, "/foo:/bar:ro") + True, False, "/foo:/bar:ro", False) self.assertEqual(id, id2) database.revoke_access( "simphonyremote/amazing", "ciccio", 'some_key', - True, False, "/foo:/bar:ro") + True, False, "/foo:/bar:ro", False) self.assertEqual(len(database.get_accounting_for_user(user)), 0) with self.assertRaises(exceptions.NotFound): database.revoke_access( "simphonyremote/amazing", "hello", 'some_key', - True, False, "/foo:/bar:ro") + True, False, "/foo:/bar:ro", False) def test_grant_revoke_access_volume(self): database = self.create_database() @@ -374,7 +375,7 @@ def test_grant_revoke_access_volume(self): database.create_application("simphonyremote/amazing") database.grant_access( "simphonyremote/amazing", "ciccio", 'some_key', - True, False, None) + True, False, None, False) user = database.get_user(user_name="ciccio") acc = database.get_accounting_for_user(user) @@ -385,10 +386,11 @@ def test_grant_revoke_access_volume(self): self.assertEqual(acc[0].application_policy.volume_source, None) self.assertEqual(acc[0].application_policy.volume_target, None) self.assertEqual(acc[0].application_policy.volume_mode, None) + self.assertEqual(acc[0].application_policy.allow_startup_data, False) database.revoke_access( "simphonyremote/amazing", "ciccio", 'some_key', - True, False, None) + True, False, None, False) self.assertEqual(len(database.get_accounting_for_user(user)), 0) @@ -399,7 +401,7 @@ def test_revoke_by_id(self): database.create_application("simphonyremote/amazing") id = database.grant_access( "simphonyremote/amazing", "ciccio", 'some_key', - True, False, None) + True, False, None, False) user = database.get_user(user_name="ciccio") apps = database.get_accounting_for_user(user) @@ -414,6 +416,30 @@ def test_revoke_by_id(self): # Id not present, should do nothing database.revoke_access_by_id(3441) + def test_allow_startup_data(self): + database = self.create_database() + + database.create_user("ciccio") + database.create_application("simphonyremote/amazing") + id = database.grant_access( + "simphonyremote/amazing", "ciccio", "some_key", + True, False, "/foo:/bar:ro", True + ) + + self.assertIsNotNone(id) + + user = database.get_user(user_name="ciccio") + acc = database.get_accounting_for_user(user) + self.assertEqual(acc[0].id, id) + self.assertEqual(acc[0].application.image, "simphonyremote/amazing") + self.assertEqual(acc[0].application_policy.app_license, 'some_key') + self.assertEqual(acc[0].application_policy.allow_home, True) + self.assertEqual(acc[0].application_policy.allow_view, False) + self.assertEqual(acc[0].application_policy.volume_source, "/foo") + self.assertEqual(acc[0].application_policy.volume_target, "/bar") + self.assertEqual(acc[0].application_policy.volume_mode, "ro") + self.assertEqual(acc[0].application_policy.allow_startup_data, True) + def test_unsupported_ops(self): """Override to silence the base class assumption that most of our backends are unable to create.""" diff --git a/remoteappmanager/docker/configurables.py b/remoteappmanager/docker/configurables.py index df5682b9b..3d8e4536d 100644 --- a/remoteappmanager/docker/configurables.py +++ b/remoteappmanager/docker/configurables.py @@ -106,6 +106,37 @@ def default_env(cls): } +class StartupData(Configurable): + """ Support opening a specific file when an application starts up. """ + + tag = "srdata" + + @classmethod + def supported_by(cls, image): + return cls.tag.upper() in image.env + + @classmethod + def config_dict_to_env(cls, config_dict): + """ The config dict must contain the tag key, e.g.: + + cls.tag = "srdata" + + {"srdata": "/home/user/can.ex2"} + """ + if config_dict is None or len(config_dict) == 0: + return cls.default_env() + + data = config_dict[cls.tag] + if not isinstance(data, str): + raise ValueError("invalid file path") + + return {cls.tag.upper(): data} + + @classmethod + def default_env(cls): + return {cls.tag.upper(): ""} + + def for_image(image): """Returns the configurables that are available for a specific image. @@ -122,7 +153,7 @@ def for_image(image): """ # We lack automatic registration. Add here new configurables - available = [Resolution] + available = [Resolution, StartupData] return [conf_class for conf_class in available diff --git a/remoteappmanager/docker/tests/test_configurables.py b/remoteappmanager/docker/tests/test_configurables.py index 54cf2568c..5bd6178f4 100644 --- a/remoteappmanager/docker/tests/test_configurables.py +++ b/remoteappmanager/docker/tests/test_configurables.py @@ -1,5 +1,7 @@ import unittest -from remoteappmanager.docker.configurables import Resolution, for_image +from remoteappmanager.docker.configurables import ( + Resolution, StartupData, for_image, +) from remoteappmanager.docker.image import Image from remoteappmanager.tests.mocking.virtual.docker_client import ( VirtualDockerClient) @@ -16,15 +18,26 @@ def setUp(self): 'simphonyproject/ubuntu-image:latest') self.image_2 = Image.from_docker_dict(image_dict) + image_dict = docker_client.inspect_image( + 'simphonyproject/simphony-paraview') + self.image_3 = Image.from_docker_dict(image_dict) + def test_resolution(self): self.assertTrue(Resolution.supported_by(self.image_1)) self.assertFalse(Resolution.supported_by(self.image_2)) + self.assertTrue(Resolution.supported_by(self.image_3)) + + def test_startup_data(self): + self.assertFalse(StartupData.supported_by(self.image_1)) + self.assertFalse(StartupData.supported_by(self.image_2)) + self.assertTrue(StartupData.supported_by(self.image_3)) def test_for_image(self): self.assertEqual(for_image(self.image_1), [Resolution]) self.assertEqual(for_image(self.image_2), []) + self.assertEqual(for_image(self.image_3), [Resolution, StartupData]) - def test_config_dict_to_env(self): + def test_config_dict_to_env_resolution(self): self.assertEqual( Resolution.config_dict_to_env({"resolution": "1280x800"}), {"X11_WIDTH": "1280", @@ -51,3 +64,18 @@ def test_config_dict_to_env(self): with self.assertRaises(ValueError): Resolution.config_dict_to_env({"resolution": "0x1024"}) + + def test_config_dict_to_env_startup_data(self): + self.assertEqual( + StartupData.config_dict_to_env({"srdata": "/home/test/can.ex2"}), + {"SRDATA": "/home/test/can.ex2"} + + ) + + default = StartupData.default_env() + self.assertEqual(default, {"SRDATA": ""}) + self.assertEqual(StartupData.config_dict_to_env(None), default) + self.assertEqual(StartupData.config_dict_to_env({}), default) + + with self.assertRaises(ValueError): + StartupData.config_dict_to_env({"srdata": 123}) diff --git a/remoteappmanager/tests/mocking/dummy.py b/remoteappmanager/tests/mocking/dummy.py index cf6150146..cd7287ab2 100644 --- a/remoteappmanager/tests/mocking/dummy.py +++ b/remoteappmanager/tests/mocking/dummy.py @@ -129,13 +129,13 @@ def list_applications(self): # pragma: no cover return self.applications.values() def grant_access(self, app_name, user_name, app_license, - allow_home, allow_view, volume): + allow_home, allow_view, volume, allow_startup_data): app = self._get_application_id_by_name(app_name) user = self._get_user_id_by_name(user_name) source, target, mode = volume.split(':') policy = DummyDBApplicationPolicy( - app_license, allow_home, allow_view, False, + app_license, allow_home, allow_view, False, allow_startup_data, source, target, mode) self.policies[len(self.policies)] = policy @@ -145,7 +145,7 @@ def grant_access(self, app_name, user_name, app_license, return id def revoke_access(self, app_name, user_name, app_license, - allow_home, allow_view, volume): + allow_home, allow_view, volume, allow_startup_data): pass def revoke_access_by_id(self, mapping_id): diff --git a/remoteappmanager/tests/mocking/virtual/docker_client.py b/remoteappmanager/tests/mocking/virtual/docker_client.py index a4a79881d..15f7d6070 100644 --- a/remoteappmanager/tests/mocking/virtual/docker_client.py +++ b/remoteappmanager/tests/mocking/virtual/docker_client.py @@ -353,4 +353,19 @@ def _init_available_images(self): SIMPHONY_NS.description: 'A vanilla Ubuntu installation', # noqa }, exposed_ports=["8888/tcp"] - )] + ), + _Image( + id="sha256:df5f5184104426b65967e016ff2ac0bfcd44ad7899ca3bbcf8e44e4461491a9e", # noqa + name="simphonyproject/simphony-paraview", + labels={ + SIMPHONY_NS.description: 'Ubuntu machine with ParaView preinstalled', # noqa + SIMPHONY_NS.ui_name: 'ParaView', + SIMPHONY_NS.type: 'vncapp', + SIMPHONY_NS_ENV['x11-width']: '', + SIMPHONY_NS_ENV['x11-height']: '', + SIMPHONY_NS_ENV['x11-depth']: '', + SIMPHONY_NS_ENV['srdata']: '', + }, + exposed_ports=["8888/tcp"] + ) + ] diff --git a/remoteappmanager/webapi/admin/accounting.py b/remoteappmanager/webapi/admin/accounting.py index 27409c87b..e11883f51 100644 --- a/remoteappmanager/webapi/admin/accounting.py +++ b/remoteappmanager/webapi/admin/accounting.py @@ -20,6 +20,7 @@ class Accounting(Resource): volume_source = Unicode(allow_none=True) volume_target = Unicode(allow_none=True) volume_mode = Unicode(allow_none=True) + allow_startup_data = Bool() @classmethod def collection_name(cls): @@ -52,6 +53,7 @@ def create(self, resource, **kwargs): resource.allow_home, True, volume, + resource.allow_startup_data, ) except db_exceptions.NotFound: raise exceptions.NotFound() @@ -97,7 +99,8 @@ def items(self, item_response, filter_=None, **kwargs): allow_home=acc.application_policy.allow_home, volume_source=acc.application_policy.volume_source, volume_target=acc.application_policy.volume_target, - volume_mode=acc.application_policy.volume_mode + volume_mode=acc.application_policy.volume_mode, + allow_startup_data=acc.application_policy.allow_startup_data, # noqa ) response.append(entry) item_response.set(response) diff --git a/remoteappmanager/webapi/admin/tests/test_accounting.py b/remoteappmanager/webapi/admin/tests/test_accounting.py index 6765c74e9..9f4ab24c3 100644 --- a/remoteappmanager/webapi/admin/tests/test_accounting.py +++ b/remoteappmanager/webapi/admin/tests/test_accounting.py @@ -49,7 +49,8 @@ def test_create(self): "allow_home": True, "volume_source": "/foo", "volume_target": "/bar", - "volume_mode": "ro" + "volume_mode": "ro", + "allow_startup_data": False, }, httpstatus.CREATED) @@ -61,7 +62,8 @@ def test_create(self): "allow_home": True, "volume_source": "/foo", "volume_target": "/bar", - "volume_mode": "ro" + "volume_mode": "ro", + "allow_startup_data": False, }, httpstatus.CREATED) @@ -77,7 +79,8 @@ def test_unable_to_create(self): "allow_home": True, "volume_source": "/foo", "volume_target": "/bar", - "volume_mode": "ro" + "volume_mode": "ro", + "allow_startup_data": False, }, httpstatus.INTERNAL_SERVER_ERROR) @@ -89,7 +92,8 @@ def test_unexistent_user_at_create(self): "allow_home": True, "volume_source": "/foo", "volume_target": "/bar", - "volume_mode": "ro" + "volume_mode": "ro", + "allow_startup_data": False, }, httpstatus.BAD_REQUEST) @@ -105,7 +109,8 @@ def test_absent_volume(self): "allow_home": True, "volume_source": "", "volume_target": "", - "volume_mode": "" + "volume_mode": "", + "allow_startup_data": False, }, httpstatus.CREATED) self.assertEqual(mock_grant_access.call_args[0][5], None) diff --git a/remoteappmanager/webapi/application.py b/remoteappmanager/webapi/application.py index 3b1f11538..594f38453 100644 --- a/remoteappmanager/webapi/application.py +++ b/remoteappmanager/webapi/application.py @@ -20,6 +20,7 @@ class Policy(ResourceFragment): volume_source = Unicode(allow_none=True) volume_target = Unicode(allow_none=True) volume_mode = Unicode(allow_none=True) + allow_startup_data = Bool() class Image(ResourceFragment): diff --git a/remoteappmanager/webapi/tests/test_application.py b/remoteappmanager/webapi/tests/test_application.py index 0c50be378..3b8f9a879 100644 --- a/remoteappmanager/webapi/tests/test_application.py +++ b/remoteappmanager/webapi/tests/test_application.py @@ -52,6 +52,7 @@ def get_app(self): volume_source="foo", volume_target="bar", volume_mode="ro", + allow_startup_data=False, ) app.db.get_accounting_for_user = Mock(return_value=[ @@ -77,7 +78,8 @@ def test_items(self): 'volume_mode': 'ro', 'volume_source': 'foo', 'allow_home': True, - 'volume_target': 'bar' + 'volume_target': 'bar', + 'allow_startup_data': False }, 'name': 'boo', 'icon_128': '', @@ -95,7 +97,8 @@ def test_items(self): 'volume_mode': 'ro', 'volume_source': 'foo', 'allow_home': True, - 'volume_target': 'bar' + 'volume_target': 'bar', + 'allow_startup_data': False }, 'name': 'boo', 'type': '', @@ -144,6 +147,7 @@ def test_retrieve(self): "volume_mode": 'ro', "volume_source": "foo", "volume_target": "bar", + "allow_startup_data": False, }, 'ui_name': 'foo_ui'}}) @@ -175,6 +179,7 @@ def test_retrieve(self): "volume_mode": 'ro', "volume_source": "foo", "volume_target": "bar", + "allow_startup_data": False, }, 'configurables': [], }