Merge lp:~pitti/qtubuntu-sensors/crash-without-hw into lp:qtubuntu-sensors

[Martin Pitt]

Fix crash if there are no available sensors.

This provides the qtubuntu-sensors part of the crash fix for LP#1272294. See
the commit logs for details.

Note that this depends on ua_sensors_accelerometer_new() actually returning
NULL in the "no sensors" case instead of crashing. That part needs to get fixed
in platform-api, hence blocking this MP until that lands.

[Martin Pitt (pitti)]

Now that the platform-api fix has finally landed, I bumped the build dependency accordingly (otherwise this new test would just crash), it's now ready to land.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:52
http://jenkins.qa.ubuntu.com/job/qtubuntu-sensors-ci/35/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/qtubuntu-sensors-trusty-amd64-ci/17
    SUCCESS: http://jenkins.qa.ubuntu.com/job/qtubuntu-sensors-trusty-armhf-ci/17
        deb: http://jenkins.qa.ubuntu.com/job/qtubuntu-sensors-trusty-armhf-ci/17/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/qtubuntu-sensors-trusty-i386-ci/17

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/qtubuntu-sensors-ci/35/rebuild

review: Approve (continuous-integration)

[Sergio Schvezov (sergiusens)]

review: Approve

=== modified file 'debian/control'
--- debian/control	2014-01-15 09:48:40 +0000
+++ debian/control	2014-02-11 20:16:48 +0000
@@ -5,7 +5,7 @@
 Build-Depends: debhelper (>= 9),
                cmake,
                libgtest-dev,
-               libplatform-api1-dev,
+               libplatform-api1-dev (>= 0.20+14.04.20140211),
                libprocess-cpp-dev (>= 0.0.1+14.04.20131212),
                libubuntu-application-api-test1,
                pkg-config,

=== modified file 'plugins/sensors/core_shared_accelerometer.cpp'
--- plugins/sensors/core_shared_accelerometer.cpp	2014-01-08 11:32:40 +0000
+++ plugins/sensors/core_shared_accelerometer.cpp	2014-02-11 20:16:48 +0000
@@ -32,10 +32,13 @@
       m_minDelay(-1),
       m_minValue(0.0),
       m_maxValue(0.0),
-      m_resolution(0.0)
+      m_resolution(0.0),
+      m_available(false)
 {
     qRegisterMetaType<QSharedPointer<QAccelerometerReading> >("QSharedPointer<QAccelerometerReading>");
     m_accelerometer = ua_sensors_accelerometer_new();
+    if (m_accelerometer == NULL)
+        return;
 
     ua_sensors_accelerometer_set_reading_cb(
                 m_accelerometer,
@@ -47,16 +50,20 @@
     m_minValue = static_cast<qreal>(ua_sensors_accelerometer_get_min_value(m_accelerometer));
     m_maxValue = static_cast<qreal>(ua_sensors_accelerometer_get_max_value(m_accelerometer));
     m_resolution = static_cast<qreal>(ua_sensors_accelerometer_get_resolution(m_accelerometer));
+    m_available = true;
+
 }
 
 void core::SharedAccelerometer::start()
 {
-    ua_sensors_accelerometer_enable(m_accelerometer);
+    if (m_available)
+        ua_sensors_accelerometer_enable(m_accelerometer);
 }
 
 void core::SharedAccelerometer::stop()
 {
-    ua_sensors_accelerometer_disable(m_accelerometer);
+    if (m_available)
+        ua_sensors_accelerometer_disable(m_accelerometer);
 }
 
 qreal core::SharedAccelerometer::getMinDelay() const

=== modified file 'plugins/sensors/core_shared_accelerometer.h'
--- plugins/sensors/core_shared_accelerometer.h	2014-01-08 11:32:40 +0000
+++ plugins/sensors/core_shared_accelerometer.h	2014-02-11 20:16:48 +0000
@@ -52,6 +52,7 @@
     qreal m_minValue;
     qreal m_maxValue;
     qreal m_resolution;
+    bool m_available;
 
     // Gets called by the underlying platform when there is a new accelerometer reading
     static void onAccelerometerReadingCb(UASAccelerometerEvent *event, void *context);

=== modified file 'tests/test_sensor_api.cpp'
--- tests/test_sensor_api.cpp	2014-01-23 14:47:07 +0000
+++ tests/test_sensor_api.cpp	2014-02-11 20:16:48 +0000
@@ -48,8 +48,13 @@
     chrono::time_point<chrono::system_clock> time;
 };
 
+/*******************************************
+ *
+ * Tests with simulated sensor backend
+ *
+ *******************************************/
 
-class APITest : public testing::Test
+class SimBackendTest : public testing::Test
 {
   protected:
     virtual void SetUp()
@@ -126,7 +131,7 @@
     queue<struct OrientationEvent> orientation_events;
 };
 
-TESTP_F(APITest, CreateAccelerator, {
+TESTP_F(SimBackendTest, CreateAccelerometer, {
     set_data("create accel 0.5 1000 0.1");
 
     QAccelerometer sensor;
@@ -151,7 +156,7 @@
     EXPECT_FLOAT_EQ(reading->z(), 0.0);
 })
 
-TESTP_F(APITest, CreateOrientation, {
+TESTP_F(SimBackendTest, CreateOrientation, {
     // orientation sensor is based on acceleration
     set_data("create accel -500 500 1");
 
@@ -168,7 +173,7 @@
     EXPECT_EQ(sensor.reading()->orientation(), QOrientationReading::Undefined);
 })
 
-TESTP_F(APITest, AcceleratorEvents, {
+TESTP_F(SimBackendTest, AccelerometerEvents, {
     set_data("create accel -500 500 0.1\n"
              "10 accel 0 -9.9 0\n"
              "200 accel 1.5 400 0.5\n"
@@ -195,7 +200,7 @@
     check_accel_event(-1.0, -9.8, -0.5, 510);
 })
 
-TESTP_F(APITest, AcceleratorReadings, {
+TESTP_F(SimBackendTest, AccelerometerReadings, {
     set_data("create accel -500 500 0.1\n"
              "10 accel 0 -9.9 0\n"
              "200 accel 1.5 400 0.5\n"
@@ -232,7 +237,7 @@
     EXPECT_FLOAT_EQ(reading->z(), -0.5);
 })
 
-TESTP_F(APITest, OrientationEvents, {
+TESTP_F(SimBackendTest, OrientationEvents, {
         /* test some "parallel to coordinate axes" conditions, as well as some
          * ~ 45 degrees angles; we want a hysteresis there, i. e. it should not
          * flip back and forth when wiggling around the diagonals but only when
@@ -276,7 +281,7 @@
     check_orientation_event(QOrientationReading::FaceDown, 520);
 })
 
-TESTP_F(APITest, OrientationReading, {
+TESTP_F(SimBackendTest, OrientationReading, {
     set_data("create accel -500 500 0.1\n"
              "10 accel 0 9.8 0\n"  // TopUp
              "20 accel 6.9 6.9 0\n"  // turning left
@@ -302,3 +307,106 @@
     run_events(20);
     EXPECT_EQ(orientation_sensor.reading()->orientation(), QOrientationReading::RightUp);
 })
+
+
+/*******************************************
+ *
+ * Tests with real sensor backend
+ *
+ *******************************************/
+
+class RealBackendTest : public testing::Test
+{
+    virtual void SetUp()
+    {
+        unsetenv("UBUNTU_PLATFORM_API_BACKEND");
+    }
+};
+
+TESTP_F(RealBackendTest, CreateAccelerometer, {
+    QAccelerometer sensor;
+    // connect to the qtubuntu-sensors backend; default is dummy, and there
+    // does not seem to be a way to use data/Sensors.conf
+    sensor.setIdentifier("core.accelerometer");
+
+    // this can succeed for fail depending on whether the hardware we run this
+    // on actually exists; but it should never crash
+    if (sensor.start()) {
+        EXPECT_EQ(sensor.error(), 0);
+        EXPECT_EQ(sensor.isConnectedToBackend(), true);
+        EXPECT_EQ(sensor.accelerationMode(), QAccelerometer::Combined);
+    } else {
+        EXPECT_NE(sensor.error(), 0);
+        EXPECT_EQ(sensor.isConnectedToBackend(), false);
+    }
+
+    EXPECT_EQ(sensor.identifier(), "core.accelerometer");
+})
+
+TESTP_F(RealBackendTest, CreateOrientation, {
+    QOrientationSensor sensor;
+    // connect to the qtubuntu-sensors backend; default is dummy, and there
+    // does not seem to be a way to use data/Sensors.conf
+    sensor.setIdentifier("core.orientation");
+
+    // this can succeed for fail depending on whether the hardware we run this
+    // on actually exists; but it should never crash
+    if (sensor.start()) {
+        EXPECT_EQ(sensor.error(), 0);
+        EXPECT_EQ(sensor.isConnectedToBackend(), true);
+    } else {
+        EXPECT_NE(sensor.error(), 0);
+        EXPECT_EQ(sensor.isConnectedToBackend(), false);
+    }
+
+    EXPECT_EQ(sensor.identifier(), "core.orientation");
+})
+
+/*******************************************
+ *
+ * Tests with default sensor backend
+ *
+ *******************************************/
+
+class DefaultBackendTest : public testing::Test
+{
+    virtual void SetUp()
+    {
+        unsetenv("UBUNTU_PLATFORM_API_BACKEND");
+    }
+};
+
+TESTP_F(DefaultBackendTest, CreateAccelerometer, {
+    QAccelerometer sensor;
+    // don't set any particular identifier here
+
+    // this can succeed for fail depending on whether the hardware we run this
+    // on actually exists; but it should never crash
+    if (sensor.start()) {
+        EXPECT_EQ(sensor.error(), 0);
+        EXPECT_EQ(sensor.isConnectedToBackend(), true);
+    } else {
+        EXPECT_NE(sensor.error(), 0);
+        EXPECT_EQ(sensor.isConnectedToBackend(), false);
+    }
+
+    cout << "default backend connected to " << sensor.identifier().constData() << endl;
+})
+
+TESTP_F(DefaultBackendTest, CreateOrientation, {
+    QOrientationSensor sensor;
+    // don't set any particular identifier here
+
+    // this can succeed for fail depending on whether the hardware we run this
+    // on actually exists; but it should never crash
+    if (sensor.start()) {
+        EXPECT_EQ(sensor.error(), 0);
+        EXPECT_EQ(sensor.isConnectedToBackend(), true);
+    } else {
+        EXPECT_NE(sensor.error(), 0);
+        EXPECT_EQ(sensor.isConnectedToBackend(), false);
+    }
+
+    cout << "default backend connected to " << sensor.identifier().constData() << endl;
+})
+