Merge lp:unity-scopes-api/staging into lp:unity-scopes-api

[Paweł Stołowski]

Merged devel (support UNITY_SCOPES_CONFIG_DIR env var, print warnings if ChildScopes option is used in the ini file).

Merged devel (support UNITY_SCOPES_CONFIG_DIR env var, print warnings if ChildScopes option is used in the ini file).

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:287
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-ci/614/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-wily-amd64-ci/2
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-wily-armhf-ci/2
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-wily-armhf-ci/2/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-wily-i386-ci/2

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-ci/614/rebuild

review: Approve (continuous-integration)

[lp:unity-scopes-api/staging]

288. By Paweł Stołowski on 2015-06-16

Bumped version

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:288
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-ci/615/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-wily-amd64-ci/3
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-wily-armhf-ci/3
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-wily-armhf-ci/3/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-wily-i386-ci/3

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-ci/615/rebuild

review: Approve (continuous-integration)

[Michi Henning (michihenning)]

Looks good, thanks!

review: Approve

[lp:unity-scopes-api/staging]

289. By Paweł Stołowski on 2015-06-17

Merged devel

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2015-05-18 13:09:19 +0000
+++ CMakeLists.txt	2015-06-17 13:53:56 +0000
@@ -218,7 +218,7 @@
 # API version
 set(UNITY_SCOPES_MAJOR 0)
 set(UNITY_SCOPES_MINOR 6)
-set(UNITY_SCOPES_MICRO 18)
+set(UNITY_SCOPES_MICRO 19)
 set(UNITY_SCOPES_SOVERSION 3)
 
 # Version for testing, with all symbols visible

=== modified file 'CONFIGFILES'
--- CONFIGFILES	2015-06-08 08:25:38 +0000
+++ CONFIGFILES	2015-06-17 13:53:56 +0000
@@ -127,6 +127,9 @@
 
   The default value is $HOME/.cache/unity-scopes.
 
+  The environment variable UNITY_SCOPES_CONFIG_DIR overrides this key (useful when running
+  automated tests that should not overwrite any of the real configuration files).
+
 - LogDir
 
   The parent directory under which the run time writes the scope log files.
@@ -379,6 +382,8 @@
   Note: make sure there are no trailing spaces following
   the ids, as they will be preserved.
 
+  This option is deprecated, please reimplement ScopeBase::find_child_scopes() instead.
+
 - Invisible (undocumented)
 
   Whether the scope is hidden in the UI. The default value is false.

=== modified file 'debian/changelog'
--- debian/changelog	2015-06-09 12:21:21 +0000
+++ debian/changelog	2015-06-17 13:53:56 +0000
@@ -1,3 +1,9 @@
+unity-scopes-api (0.6.19-0ubuntu1) UNRELEASED; urgency=medium
+
+  * Support UNITY_SCOPES_CONFIG_DIR environment variable.
+
+ -- Pawel Stolowski <[e-mail]>  Tue, 16 Jun 2015 13:53:20 +0000
+
 unity-scopes-api (0.6.18+15.10.20150609.1-0ubuntu1) wily; urgency=medium
 
   [ Marcus Tomlinson ]

=== modified file 'src/scopes/internal/RuntimeConfig.cpp'
--- src/scopes/internal/RuntimeConfig.cpp	2015-04-10 03:55:25 +0000
+++ src/scopes/internal/RuntimeConfig.cpp	2015-06-17 13:53:56 +0000
@@ -127,7 +127,10 @@
             }
         }
 
-        config_directory_ = get_optional_string(runtime_config_group, config_dir_key);
+        // UNITY_SCOPES_CONFIG_DIR env var can be used to override the value of ConfigDir key of Runtime.ini
+        char const* scopes_cfg_dir_override = getenv("UNITY_SCOPES_CONFIG_DIR");
+        config_directory_ = (scopes_cfg_dir_override != nullptr && scopes_cfg_dir_override != '\0') ?
+            string(scopes_cfg_dir_override) : get_optional_string(runtime_config_group, config_dir_key);
         if (config_directory_.empty())
         {
             try

=== modified file 'src/scopes/internal/ScopeConfig.cpp'
--- src/scopes/internal/ScopeConfig.cpp	2015-06-08 08:25:38 +0000
+++ src/scopes/internal/ScopeConfig.cpp	2015-06-17 13:53:56 +0000
@@ -214,6 +214,7 @@
     try
     {
         child_scope_ids_ = parser()->get_string_array(scope_config_group, child_scope_ids_key);
+        cerr << "Warning: the " << child_scope_ids_key << " option is deprecated. Please reimplement ScopeBase::find_child_scopes() instead." << endl;
     }
     catch (LogicException const&)
     {

=== modified file 'test/gtest/scopes/Variant/Variant_test.cpp'
--- test/gtest/scopes/Variant/Variant_test.cpp	2015-03-30 15:58:45 +0000
+++ test/gtest/scopes/Variant/Variant_test.cpp	2015-06-17 13:53:56 +0000
@@ -245,7 +245,8 @@
 
     {
         Variant v(10.5f);
-        EXPECT_EQ("10.50\n", v.serialize_json());
+        auto const str = v.serialize_json();
+        EXPECT_TRUE(str == "10.50\n" || str == "10.5\n");
     }
 
     {

=== modified file 'test/gtest/scopes/internal/RuntimeConfig/RuntimeConfig_test.cpp'
--- test/gtest/scopes/internal/RuntimeConfig/RuntimeConfig_test.cpp	2015-04-10 03:55:25 +0000
+++ test/gtest/scopes/internal/RuntimeConfig/RuntimeConfig_test.cpp	2015-06-17 13:53:56 +0000
@@ -30,7 +30,15 @@
 using namespace unity::scopes;
 using namespace unity::scopes::internal;
 
-TEST(RuntimeConfig, basic)
+class RuntimeConfigTest: public ::testing::Test {
+    public:
+        virtual void SetUp()
+        {
+            unsetenv("UNITY_SCOPES_CONFIG_DIR");
+        }
+};
+
+TEST_F(RuntimeConfigTest, basic)
 {
     setenv("HOME", TEST_DIR, 1);
 
@@ -48,7 +56,7 @@
     EXPECT_TRUE(c.trace_channels().empty());
 }
 
-TEST(RuntimeConfig, complete)
+TEST_F(RuntimeConfigTest, complete)
 {
     RuntimeConfig c(TEST_DIR "/Complete.ini");
     EXPECT_EQ("R.Id", c.registry_identity());
@@ -68,7 +76,7 @@
     EXPECT_EQ(vector<string>{ "IPC" }, c.trace_channels());
 }
 
-TEST(RuntimeConfig, _default_cache_dir)
+TEST_F(RuntimeConfigTest, _default_cache_dir)
 {
     setenv("HOME", TEST_DIR, 1);
 
@@ -76,69 +84,78 @@
     EXPECT_EQ(TEST_DIR "/.local/share/unity-scopes", c.cache_directory());
 }
 
-TEST(RuntimeConfig, overridden_cache_dir)
-{
-    unsetenv("HOME");
-
-    RuntimeConfig c(TEST_DIR "/CacheDir.ini");
-    EXPECT_EQ("cachedir", c.cache_directory());
-}
-
-TEST(RuntimeConfig, overridden_cache_dir_with_home_dir)
-{
-    setenv("HOME", TEST_DIR, 1);
-
-    RuntimeConfig c(TEST_DIR "/CacheDir.ini");
-    EXPECT_EQ("cachedir", c.cache_directory());
-}
-
-TEST(RuntimeConfig, overridden_app_dir)
-{
-    unsetenv("HOME");
-
-    RuntimeConfig c(TEST_DIR "/CacheDir.ini");
-    EXPECT_EQ("appdir", c.app_directory());
-}
-
-TEST(RuntimeConfig, overridden_app_dir_with_home_dir)
-{
-    setenv("HOME", TEST_DIR, 1);
-
-    RuntimeConfig c(TEST_DIR "/ConfigDir.ini");
-    EXPECT_EQ("appdir", c.app_directory());
-}
-
-TEST(RuntimeConfig, overridden_config_dir)
-{
-    unsetenv("HOME");
-
-    RuntimeConfig c(TEST_DIR "/ConfigDir.ini");
-    EXPECT_EQ("configdir", c.config_directory());
-}
-
-TEST(RuntimeConfig, overridden_config_dir_with_home_dir)
-{
-    setenv("HOME", TEST_DIR, 1);
-
-    RuntimeConfig c(TEST_DIR "/ConfigDir.ini");
-    EXPECT_EQ("configdir", c.config_directory());
-}
-
-TEST(RuntimeConfig, overridden_log_dir)
-{
-    unsetenv("HOME");
-
-    RuntimeConfig c(TEST_DIR "/LogDir.ini");
-    EXPECT_EQ("logdir", c.log_directory());
-}
-
-TEST(RuntimeConfig, overridden_log_dir_with_home_dir)
-{
-    RuntimeConfig c(TEST_DIR "/LogDir.ini");
-    EXPECT_EQ("logdir", c.log_directory());
-}
-
-TEST(RuntimeConfig, log_dir_env_var_override)
+TEST_F(RuntimeConfigTest, overridden_cache_dir)
+{
+    unsetenv("HOME");
+
+    RuntimeConfig c(TEST_DIR "/CacheDir.ini");
+    EXPECT_EQ("cachedir", c.cache_directory());
+}
+
+TEST_F(RuntimeConfigTest, overridden_cache_dir_with_home_dir)
+{
+    setenv("HOME", TEST_DIR, 1);
+
+    RuntimeConfig c(TEST_DIR "/CacheDir.ini");
+    EXPECT_EQ("cachedir", c.cache_directory());
+}
+
+TEST_F(RuntimeConfigTest, overridden_app_dir)
+{
+    unsetenv("HOME");
+
+    RuntimeConfig c(TEST_DIR "/CacheDir.ini");
+    EXPECT_EQ("appdir", c.app_directory());
+}
+
+TEST_F(RuntimeConfigTest, overridden_app_dir_with_home_dir)
+{
+    setenv("HOME", TEST_DIR, 1);
+
+    RuntimeConfig c(TEST_DIR "/ConfigDir.ini");
+    EXPECT_EQ("appdir", c.app_directory());
+}
+
+TEST_F(RuntimeConfigTest, overridden_config_dir)
+{
+    unsetenv("HOME");
+
+    RuntimeConfig c(TEST_DIR "/ConfigDir.ini");
+    EXPECT_EQ("configdir", c.config_directory());
+}
+
+TEST_F(RuntimeConfigTest, overridden_config_dir_with_home_dir)
+{
+    setenv("HOME", TEST_DIR, 1);
+
+    RuntimeConfig c(TEST_DIR "/ConfigDir.ini");
+    EXPECT_EQ("configdir", c.config_directory());
+}
+
+TEST_F(RuntimeConfigTest, overridden_config_dir_with_unity_scopes_cfg_dir)
+{
+    setenv("HOME", TEST_DIR, 1);
+    setenv("UNITY_SCOPES_CONFIG_DIR", "foobar", 1);
+
+    RuntimeConfig c(TEST_DIR "/ConfigDir.ini");
+    EXPECT_EQ("foobar", c.config_directory());
+}
+
+TEST_F(RuntimeConfigTest, overridden_log_dir)
+{
+    unsetenv("HOME");
+
+    RuntimeConfig c(TEST_DIR "/LogDir.ini");
+    EXPECT_EQ("logdir", c.log_directory());
+}
+
+TEST_F(RuntimeConfigTest, overridden_log_dir_with_home_dir)
+{
+    RuntimeConfig c(TEST_DIR "/LogDir.ini");
+    EXPECT_EQ("logdir", c.log_directory());
+}
+
+TEST_F(RuntimeConfigTest, log_dir_env_var_override)
 {
     setenv("UNITY_SCOPES_LOGDIR", "otherdir", 1);
 
@@ -146,7 +163,7 @@
     EXPECT_EQ("otherdir", c.log_directory());
 }
 
-TEST(RuntimeConfig, trace_channels_env_var_override)
+TEST_F(RuntimeConfigTest, trace_channels_env_var_override)
 {
     setenv("UNITY_SCOPES_LOG_TRACECHANNELS", "ABC;XYZ;;DEF", 1);
 
@@ -154,7 +171,7 @@
     EXPECT_EQ((vector<string>{ "ABC", "XYZ", "DEF"}), c.trace_channels());
 }
 
-TEST(RuntimeConfig, exceptions)
+TEST_F(RuntimeConfigTest, exceptions)
 {
     try
     {