unity-scopes-api

Deployment directories for scopes conflict with packaging

Bug #1274421 reported by Michi Henning
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
unity-scopes-api
Fix Released
High
Michi Henning

Bug Description

Currently scopes need to be installed in a single directory that contains both the scope .ini file and the shared lib. Apparently packaging needs the library in one place /usr/lib/whatever??? and the .ini file in another place /usr/share/whatever???. And some scopes (click-packages) will be installed in /usr/.local/whatever???

Please comment on what the actual locations will be, so we can adjust the config accordingly.

Related branches

lp:~michihenning/unity-scopes-api/config-fixes
PS Jenkins bot (community): Approve (continuous-integration)
Marcus Tomlinson (community): Approve
Michal Hruby (community): Approve
Diff: 3858 lines (+1129/-643)
103 files modified
CMakeLists.txt (+13/-14)
CONFIGFILES (+208/-0)
RELEASE_NOTES.md (+13/-2)
data/CMakeLists.txt (+2/-10)
data/Registry.ini.in (+0/-10)
data/Runtime.ini.in (+0/-5)
data/SSRegistry.ini.in (+0/-7)
data/SSRuntime.ini.in (+0/-5)
data/Zmq.ini.in (+0/-3)
data/libunity-scopes.pc.in (+3/-1)
data/scope-registry.conf.in (+1/-1)
data/smart-scopes-proxy.conf.in (+1/-1)
debian/changelog (+24/-3)
debian/libunity-scopes-doc.install (+1/-1)
debian/libunity-scopes1.install (+3/-4)
debian/libunity-scopes1.symbols (+15/-12)
demo/CMakeLists.txt (+0/-1)
demo/README (+1/-1)
demo/Registry.ini.in (+0/-5)
demo/Runtime.ini.in (+0/-2)
demo/Zmq.ini.in (+0/-3)
demo/click/scope-click/CMakeLists.txt (+1/-1)
demo/stand-alone/CMakeLists.txt (+0/-1)
demo/stand-alone/Runtime.ini.in (+0/-2)
demo/stand-alone/Zmq.ini.in (+0/-3)
doc/Doxyfile-devel.in (+1/-1)
doc/Doxyfile.in (+1/-1)
doc/index.html (+3/-3)
include/CMakeLists.txt (+4/-4)
include/unity/scopes/Runtime.h (+9/-0)
include/unity/scopes/internal/ConfigBase.h (+13/-3)
include/unity/scopes/internal/DfltConfig.h.in (+17/-3)
include/unity/scopes/internal/MiddlewareBase.h (+3/-1)
include/unity/scopes/internal/RegistryConfig.h (+0/-10)
include/unity/scopes/internal/RegistryObject.h (+3/-2)
include/unity/scopes/internal/RuntimeConfig.h (+4/-2)
include/unity/scopes/internal/RuntimeImpl.h (+6/-7)
include/unity/scopes/internal/ScopeConfig.h (+2/-4)
include/unity/scopes/internal/smartscopes/SSConfig.h (+62/-0)
include/unity/scopes/internal/smartscopes/SSRegistryObject.h (+6/-2)
include/unity/scopes/internal/zmq_middleware/ZmqConfig.h (+0/-2)
include/unity/scopes/internal/zmq_middleware/ZmqMiddleware.h (+6/-2)
scoperegistry/CMakeLists.txt (+1/-1)
scoperegistry/scoperegistry.cpp (+6/-24)
scoperunner/CMakeLists.txt (+1/-1)
smartscopesproxy/CMakeLists.txt (+1/-1)
smartscopesproxy/smartscopesproxy.cpp (+9/-9)
src/scopes/Runtime.cpp (+6/-1)
src/scopes/internal/ConfigBase.cpp (+89/-7)
src/scopes/internal/MiddlewareFactory.cpp (+1/-1)
src/scopes/internal/RegistryConfig.cpp (+33/-33)
src/scopes/internal/RegistryObject.cpp (+59/-27)
src/scopes/internal/RuntimeConfig.cpp (+45/-20)
src/scopes/internal/RuntimeImpl.cpp (+30/-41)
src/scopes/internal/ScopeConfig.cpp (+57/-35)
src/scopes/internal/smartscopes/CMakeLists.txt (+1/-0)
src/scopes/internal/smartscopes/SSConfig.cpp (+129/-0)
src/scopes/internal/smartscopes/SSRegistryObject.cpp (+7/-8)
src/scopes/internal/zmq_middleware/ZmqConfig.cpp (+36/-15)
src/scopes/internal/zmq_middleware/ZmqMiddleware.cpp (+64/-66)
src/scopes/internal/zmq_middleware/ZmqObject.cpp (+6/-33)
test/gtest/scopes/Activation/Activation_test.cpp (+1/-1)
test/gtest/scopes/Activation/Registry.ini.in (+0/-2)
test/gtest/scopes/Activation/Zmq.ini.in (+1/-2)
test/gtest/scopes/Filters/Filters_test.cpp (+1/-1)
test/gtest/scopes/Filters/Registry.ini.in (+0/-2)
test/gtest/scopes/Filters/Zmq.ini.in (+1/-2)
test/gtest/scopes/Invocation/Invocation_test.cpp (+3/-3)
test/gtest/scopes/Invocation/Registry.ini.in (+0/-2)
test/gtest/scopes/Invocation/Zmq.ini.in (+1/-2)
test/gtest/scopes/Registry/RegistryTest.ini.in (+0/-2)
test/gtest/scopes/Registry/Registry_test.cpp (+3/-0)
test/gtest/scopes/Registry/Runtime.ini.in (+1/-0)
test/gtest/scopes/Registry/Zmq.ini.in (+1/-2)
test/gtest/scopes/Registry/scopes/testscopeB/testscopeB.cpp (+1/-1)
test/gtest/scopes/Runtime/Registry.ini.in (+0/-2)
test/gtest/scopes/Runtime/Runtime_test.cpp (+9/-9)
test/gtest/scopes/Runtime/Zmq.ini.in (+1/-2)
test/gtest/scopes/internal/ConfigBase/ConfigBase_test.cpp (+31/-15)
test/gtest/scopes/internal/RegistryConfig/Registry.ini.in (+0/-2)
test/gtest/scopes/internal/RegistryConfig/RegistryConfig_test.cpp (+0/-1)
test/gtest/scopes/internal/RegistryConfig/ScoperunnerRelativePath.ini.in (+0/-1)
test/gtest/scopes/internal/ResultReplyObject/Registry.ini.in (+0/-2)
test/gtest/scopes/internal/ResultReplyObject/Zmq.ini.in (+1/-2)
test/gtest/scopes/internal/RuntimeConfig/RuntimeConfig_test.cpp (+0/-29)
test/gtest/scopes/internal/RuntimeImpl/Registry.ini.in (+1/-3)
test/gtest/scopes/internal/RuntimeImpl/Zmq.ini.in (+1/-2)
test/gtest/scopes/internal/ScopeMetadataImpl/ScopeMetadataImpl_test.cpp (+4/-4)
test/gtest/scopes/internal/ScopeMetadataImpl/Zmq.ini.in (+1/-2)
test/gtest/scopes/internal/smartscopes/smartscopesproxy/SSRegistryTest.ini.in (+0/-5)
test/gtest/scopes/internal/smartscopes/smartscopesproxy/Zmq.ini.in (+1/-2)
test/gtest/scopes/internal/smartscopes/smartscopesproxy/smartscopesproxy_test.cpp (+4/-2)
test/gtest/scopes/internal/zmq_middleware/ObjectAdapter/ObjectAdapter_test.cpp (+33/-32)
test/gtest/scopes/internal/zmq_middleware/ObjectAdapter/Zmq.ini.in (+1/-2)
test/gtest/scopes/internal/zmq_middleware/RegistryI/RegistryI_test.cpp (+3/-8)
test/gtest/scopes/internal/zmq_middleware/RegistryI/TestRegistry.ini.in (+0/-5)
test/gtest/scopes/internal/zmq_middleware/RegistryI/Zmq.ini.in (+1/-2)
test/gtest/scopes/internal/zmq_middleware/ServantBase/ServantBase_test.cpp (+6/-6)
test/gtest/scopes/internal/zmq_middleware/ServantBase/Zmq.ini.in (+1/-2)
test/gtest/scopes/internal/zmq_middleware/ZmqMiddleware/Zmq.ini.in (+1/-2)
test/gtest/scopes/internal/zmq_middleware/ZmqMiddleware/ZmqMiddleware_test.cpp (+6/-8)
test/whitespace/check_whitespace.py (+1/-1)
unity-scopes.map (+1/-0)
Revision history for this message
Michi Henning (michihenning) wrote :

Some development discussions here: https://docs.google.com/a/canonical.com/document/d/1eNOb1hQv08-NsdGgWvycdK6BrvL5WB0cThhH3wII-GY/edit

Revision history for this message
Jussi Pakkanen (jpakkane) wrote :

Ignoring multiarch issues, shared libraries need to be installed under /usr/lib/archname, probably under some subdirectory, say, unity-scopes. In CMake parlance this would mean ${CMAKE_INSTALL_LIBDIR}/unity-scopes.

As far as conf files go, should they go under share or etc? I'm guessing the former but don't really know. Current scopes install stuff to /usr/share/unity-scopes, but those seem to contain only Python modules.

Revision history for this message
James Henstridge (jamesh) wrote :

The primary rule is no platform dependent code in /usr/share. It would be acceptable to have both the scope library/executable and the .ini file together under /usr/lib, if that is preferable.

Revision history for this message
James Henstridge (jamesh) wrote :

We should only put the .ini files under /etc if we truely consider them to be configuration files as opposed to data files.

So I think they either belong under /usr/lib (if we consider them to be platform dependent configuration files), or /usr/share (if they are platform independent).

Michal Hruby (mhr3)
Changed in unity-scopes-api:
importance: Undecided → High
status: New → Triaged
assignee: nobody → Michi Henning (michihenning)
Revision history for this message
Michi Henning (michihenning) wrote :

The config files are platform independent.

In /usr/share, we already have:

- unity
- unity8
- unity-greeter
- unity-lens-friends
- unity-scopes
- unity-webapps

I'm reluctant to install things into either unity or unity-scopes because there is stuff there already, and I think it could be really confusing to mix the old and the new files in the same hierarchy. So, how about /usr/share/unity-scopes-api as the root dir for the config files?

Revision history for this message
Michi Henning (michihenning) wrote :

Anyone know what the OEM directory is called? Would be nice to know.

Assuming that it's called, say, "OEM", I'm suggesting to have the exact same hierarchy that we have for everything else under there. So, if we use

/usr/share/unity-scopes-api/scopes/MyScope.ini

then, for the OEM, it would be

/OEM/usr/share/unity-scopes-api/scopes/TheirScope.ini

Comments?

Revision history for this message
Michal Hruby (mhr3) wrote :

> /OEM/usr/share/unity-scopes-api/scopes/TheirScope.ini

> Comments?

OEM-specifics live in /custom, IIRC the XDG_DATA_DIRS envvar is modified to include the OEM-specific data directories (where /usr/share/ is the default one)

Revision history for this message
Chris Wayne (cwayne) wrote :

Yes, we include /custom/xdg/data in XDG_DATA_DIRS, so from our point of view, it'd be best to have unity8 just look in XDG_DATA_DIRS instead of a hardcoded list of directories. This is a blocker from our point of view

Revision history for this message
Michi Henning (michihenning) wrote :

/custom is fine with me for the OEM dir.

I don't think looking in XDG_DATA_DIRS is all that great. There may be several of them. Which one would we use? Try all of them do search for OEM scopes? Also, the scope config will be architecture-specific, so we'll be looking in /lib for the config.

Can you comment on what exactly the "blocker" is? I don't think I'm seeing the full picture...

Revision history for this message
Chris Wayne (cwayne) wrote :

The blocker is that we don't install debs for custom images, so we can't put scopes in /usr/share, so without this, we can't have demo scopes on the MWC image, which is a blocker

Revision history for this message
Michi Henning (michihenning) wrote :

I want to give scopes a writeable data directory, for scopes that want to write cache files, or whatever.

The most sensible location would be somewhere under $HOME, I would think. (AppArmor can make sure that the scope can't write to locations outside its assigned directory.)

What path should we use for that? Any suggestions?

Michi Henning (michihenning)
Changed in unity-scopes-api:
status: Triaged → In Progress
Michal Hruby (mhr3)
Changed in unity-scopes-api:
status: In Progress → Fix Released
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :

Fix committed into lp:unity-scopes-api/devel at revision 323, scheduled for release in unity-scopes-api, milestone Unknown

Changed in unity-scopes-api:
status: Fix Released → Fix Committed
Michal Hruby (mhr3)
Changed in unity-scopes-api:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.