TimingFunction test helper.

Source/core/platform/animation/TimingFunctionTestHelperTest.cpp

+/*
+ * Copyright (c) 2013, Google Inc. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following disclaimer
+ * in the documentation and/or other materials provided with the
+ * distribution.
+ *     * Neither the name of Google Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "config.h"
+
+#include "core/platform/animation/TimingFunctionTestHelper.h"
+
+#include <gmock/gmock.h>
+#include <gtest/gtest.h>
+#include <sstream>
+#include <string>
+
+
+using namespace WebCore;
+
+namespace {
+
+class TimingFunctionTestHelperTest : public ::testing::Test {

[shans, 2013/10/31 20:22:54]

I'm not a huge fan of these tests:
(1) If TimingFunctionTestHelper is used elsewhere for testing then the
expectations on those tests will break if TimingFunctionTestHelper does
(2) It isn't necessary for TimingFunctionTestHelper to work in order for Blink
to.
(3) You're not really testing any invariants here - just that the arbitrary
print string you selected is the one that gets printed. These tests make it
harder to change that print string later.

[Steve Block, 2013/11/03 09:18:32]

I tend to agree. At a higher level, why do we have to print a timing function to
a string in order to test it? Isn't it better to expose methods to interrogate
the timing function directly, rather than using a print method and a regex to
test via a string?

[mithro-old, 2013/11/03 09:58:24]

I think there is a misunderstand what is going on here. 

This code is testing the **PrintTo methods**, not the TimingFunction code.
Nobody outside of the test for PrintTo itself should be calling PrintTo method
directly.

The PrintTo methods simple trivial at first and I originally didn't write any
tests for them. However, it turns out there is actually some very complex
behaviour going on behind the scenes in gtest. After having being bitten by this
a number of times I ended up writing these tests to prove that the PrintTo code
was working as expected (and actually discovered a couple of other minor issues
in the process).

On why the PrintTo methods are useful; the PrintTo functions are used during
testing of other code via the testing framework to give you useful error
messages when something goes wrong. If you did an
EXPECT_EQ(CubicTimingFunction::preset(EaseIn), GenerateTimingFunction()) and the
expectation fails, gtest will output the following.

 Without the PrintTo methods you get;

   EXPECT_EQ failed on Line XX in function XX:
   Expected not equal to actual
   Expected: CubicTimingFunction::preset(EaseIn)
   Which is: <Object 18 bytes>
     Actual: GenerateTimingFunction()
   Which is: <Object 18 bytes>

 With the PrintTo methods you get;

   EXPECT_EQ failed on Line XX in function XX:
   Expected not equal to actual
   Expected: CubicTimingFunction::preset(EaseIn)
   Which is: CubicTimingFunction(EaseIn, 0.0, 1.0, 0.0, 0.45)
     Actual: GenerateTimingFunction()
   Which is: LinearTimingFunction()

Much easier to see why your test is failing!

Does that make more sense?

[Steve Block, 2013/11/03 23:29:44]

I see. I misunderstood your comment about the motivation for these printTo()
methods. I thought you were suggesting they were to be used for testing, but in
fact they're just to help debug failing tests.

+
+protected:
+    bool m_enabled;
+
+    virtual void SetUp()
+    {
+        m_enabled = RuntimeEnabledFeatures::webAnimationsEnabled();
+        // Needed for ChainedTimingFunction support
+        RuntimeEnabledFeatures::setWebAnimationsEnabled(true);
+    }
+
+    virtual void TearDown()
+    {
+        RuntimeEnabledFeatures::setWebAnimationsEnabled(m_enabled);
+    }
+
+public:
+    // Make sure that the CubicBezierTimingFunction call goes via the generic
+    // TimingFunction PrintTo.
+    ::std::string PrintToString(RefPtr<CubicBezierTimingFunction> timing)
+    {
+        RefPtr<TimingFunction> generic = timing;
+        return PrintToString(generic.get());
+    }
+
+    ::std::string PrintToString(RefPtr<TimingFunction> timing)
+    {
+        return PrintToString(timing.get());
+    }
+
+    ::std::string PrintToString(const TimingFunction* timing)
+    {
+        return ::testing::PrintToString(*timing);
+    }
+};
+
+TEST_F(TimingFunctionTestHelperTest, LinearPrintTo)
+{
+    RefPtr<TimingFunction> linearTiming = LinearTimingFunction::create();
+    EXPECT_THAT(
+        PrintToString(linearTiming),
+        ::testing::MatchesRegex("LinearTimingFunction@0x\\w+"));
+}
+
+TEST_F(TimingFunctionTestHelperTest, CubicPrintTo)
+{
+    RefPtr<TimingFunction> cubicEaseTiming = CubicBezierTimingFunction::preset(CubicBezierTimingFunction::EaseIn);
+    EXPECT_THAT(
+        PrintToString(cubicEaseTiming),
+        ::testing::MatchesRegex("CubicBezierTimingFunction@0x\\w+\\(EaseIn, 0.42, 0, 1, 1\\)"));
+
+    RefPtr<TimingFunction> cubicCustomTiming = CubicBezierTimingFunction::create(0.17, 0.67, 1, -1.73);
+    EXPECT_THAT(
+        PrintToString(cubicCustomTiming),
+        ::testing::MatchesRegex("CubicBezierTimingFunction@0x\\w+\\(Custom, 0.17, 0.67, 1, -1.73\\)"));
+}
+
+TEST_F(TimingFunctionTestHelperTest, StepPrintTo)
+{
+    RefPtr<TimingFunction> stepTimingStart = StepsTimingFunction::preset(StepsTimingFunction::Start);
+    EXPECT_THAT(
+        PrintToString(stepTimingStart),
+        ::testing::MatchesRegex("StepsTimingFunction@0x\\w+\\(Start, 1, true\\)"));
+
+    RefPtr<TimingFunction> stepTimingCustom = StepsTimingFunction::create(5, false);
+    EXPECT_THAT(
+        PrintToString(stepTimingCustom),
+        ::testing::MatchesRegex("StepsTimingFunction@0x\\w+\\(Custom, 5, false\\)"));
+}
+
+TEST_F(TimingFunctionTestHelperTest, ChainedPrintTo)
+{
+    RefPtr<TimingFunction> linearTiming = LinearTimingFunction::create();
+    RefPtr<ChainedTimingFunction> chainedLinearSingle = ChainedTimingFunction::create();
+    chainedLinearSingle->appendSegment(1.0, linearTiming.get());
+    EXPECT_THAT(
+        PrintToString(chainedLinearSingle),
+        ::testing::MatchesRegex(
+            "ChainedTimingFunction@0x\\w+\\("
+                "LinearTimingFunction@0x\\w+\\[0 -> 1\\]"
+            "\\)"));
+
+    RefPtr<TimingFunction> cubicCustomTiming = CubicBezierTimingFunction::create(1.0, 0.0, 1, -1);
+
+    RefPtr<ChainedTimingFunction> chainedMixed = ChainedTimingFunction::create();
+    chainedMixed->appendSegment(0.75, chainedLinearSingle.get());
+    chainedMixed->appendSegment(1.0, cubicCustomTiming.get());
+    EXPECT_THAT(
+        PrintToString(chainedMixed),
+        ::testing::MatchesRegex(
+            "ChainedTimingFunction@0x\\w+\\("
+                "ChainedTimingFunction@0x\\w+\\("
+                    "LinearTimingFunction@0x\\w+\\[0 -> 1\\]"
+                "\\)\\[0 -> 0.75\\], "
+                "CubicBezierTimingFunction@0x\\w+\\(Custom, 1, 0, 1, -1\\)\\[0.75 -> 1\\]"
+            "\\)"));
+}
+
+} // namespace