Bug: client.createClient(False) in scripts fails

[jamoore]

See:

• ​http://lists.openmicroscopy.org.uk/pipermail/ome-users/2014-September/004691.html
• #12388

The following script fails:

import omero
from omero import scripts

c = omero.scripts.client("test.py")
copy = c.createClient(secure=False)

with

        *** start stderr (id=62)***
        * Traceback (most recent call last):
        *   File "./script", line 15, in <module>
        *     copy = c.createClient(secure=False)
        *   File "/opt/ome3/dist/lib/python/omero/clients.py", line 340, in createClient
        *     nClient = omero.client(props)
        *   File "/opt/ome3/dist/lib/python/omero/__init__.py", line 67, in client
        *     return omero.clients.BaseClient(*args, **kwargs)
        *   File "/opt/ome3/dist/lib/python/omero/clients.py", line 140, in __init__
        *     self._initData(id)
        *   File "/opt/ome3/dist/lib/python/omero/clients.py", line 263, in _initData
        *     raise omero.ClientError(msg)
        * omero.ClientError: No host specified. Use omero.client(HOSTNAME), ICE_CONFIG, or similar.
        * 
        *** end stderr ***

[bpindelski]

After some digging around the code, I can see that ​https://github.com/openmicroscopy/openmicroscopy/blob/develop/components/tools/OmeroPy/src/omero/scripts.py#L365 indirectly calls ​https://github.com/openmicroscopy/openmicroscopy/blob/develop/components/tools/OmeroPy/src/omero/scripts.py#L365, which then fails to init, as none of the parameters are provided (especially "host"). Does that mean that fixing this ticket is to guarantee some reasonable defaults for missing params in that "init" method (i.e. "localhost" if "host" not set)?

[jamoore]

Largely what's going on here is that behind the firewall (i.e. within icegrid) we are just given Ice.Default.Router or possibly Ice.Default.Locator) since omero.host is really just a way for omero.client to build up the correct connection string outside the firewall. There are 2 rather straight-forward options as I see it:

1) parse out omero.host as I told Carnë and just set the value. This is a bit brittle but will *almost* always hold.

2) find the locations inside the firewall that are currently (wrongly) depending on omero.host and move them to using only Ice.Default.Router.

[bpindelski]

I see. After reading the code a bit further, the error seems to stem from this line: ​https://github.com/openmicroscopy/openmicroscopy/blob/develop/components/tools/OmeroPy/src/omero/clients.py#L238. And the specific error message from the script executed inside the server is expected an endpoint option but found `not' in endpoint `tcp -p 4063 -h <"omero.host" not set>'. As far as I see, the line that calls getPropertyWithDefault would need a different default?
Or the whole part where the router is set in clients.py needs refactoring? This is very much Ice-specific, so I'm a bit lost here.

[bpindelski]

As I'm not able to do

router = self.getCommunicator().stringToProxy(router)
for endpoint in router.ice_getEndpoints():
    host = endpoint.getInfo().host

because there is not communicator yet on line ​https://github.com/openmicroscopy/openmicroscopy/blob/develop/components/tools/OmeroPy/src/omero/clients.py#L238, I presume the sane solution is to substitute <"omero.host" not set> with localhost.

[jamoore]

Unfortunately defaulting to localhost is dangerous. We've done that elsewhere, but unfortunately also counts as a bug (of the form that Douglas would certainly run into). Instead we would have to delay the setting until there is a communicator and/or router.

[bpindelski]

PR now open ​https://github.com/openmicroscopy/openmicroscopy/pull/3121.

[jamoore]

Merged

[Josh Moore <josh.moore@…>]

(In [199022297b2f6d27475d006bf31f6ce0b2ff16cd/ome.git] on branch develop) Merge pull request #3121 from bpindelski/12555_create_client

Make sure @omero_host@ is never present (fix #12555).