Bug 1027255: Add ASSERT_/EXPECT_ GTest helpers for mozilla::pkix::Result, r=mmc

--HG--
extra : rebase_source : 2fb8807724ba59028ec32e8d287296a905bd3615

security/pkix/test/gtest/moz.build

@@ -14,6 +14,7 @@ SOURCES += [
     'pkixder_input_tests.cpp',
     'pkixder_pki_types_tests.cpp',
     'pkixder_universal_types_tests.cpp',
+    'pkixgtest.cpp',
 ]
 
 LOCAL_INCLUDES += [

security/pkix/test/gtest/nssgtest.h

@@ -44,7 +44,7 @@ public:
   {
   }
 
-  SECStatusWithPRErrorCode(SECStatus rv)
+  explicit SECStatusWithPRErrorCode(SECStatus rv)
     : mRv(rv)
     , mErrorCode(rv == SECSuccess ? 0 : PR_GetError())
   {
@@ -62,7 +62,7 @@ private:
   friend std::ostream& operator<<(std::ostream& os,
                                   SECStatusWithPRErrorCode const& value);
 
-  void operator=(const SECStatusWithPRErrorCode&) /*delete*/;
+  void operator=(const SECStatusWithPRErrorCode&) /*= delete*/;
 };
 
 ::std::ostream& operator<<(::std::ostream&,

security/pkix/test/gtest/pkixgtest.cpp

@@ -0,0 +1,62 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=2 et sw=2 tw=80: */
+/* This code is made available to you under your choice of the following sets
+ * of licensing terms:
+ */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+/* Copyright 2014 Mozilla Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "pkixgtest.h"
+
+namespace mozilla { namespace pkix { namespace test {
+
+std::ostream&
+operator<<(std::ostream& os, const ResultWithPRErrorCode& value)
+{
+  switch (value.mRv)
+  {
+    case Success:
+      os << "Success";
+      break;
+    case RecoverableError:
+      os << "RecoverableError";
+      break;
+    case SECFailure:
+      os << "FatalError";
+      break;
+    default:
+      os << "[Invalid Result: " << static_cast<int64_t>(value.mRv) << ']';
+      break;
+  }
+
+  if (value.mRv != Success) {
+    os << '(';
+    const char* name = PR_ErrorToName(value.mErrorCode);
+    if (name) {
+      os << name;
+    } else {
+      os << value.mErrorCode;
+    }
+    os << ')';
+  }
+
+  return os;
+}
+
+} } } // namespace mozilla::pkix::test

security/pkix/test/gtest/pkixgtest.h

@@ -0,0 +1,97 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=2 et sw=2 tw=80: */
+/* This code is made available to you under your choice of the following sets
+ * of licensing terms:
+ */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+/* Copyright 2014 Mozilla Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#ifndef mozilla_pkix__pkixgtest_h
+#define mozilla_pkix__pkixgtest_h
+
+#include <ostream>
+
+#include "gtest/gtest.h"
+#include "pkixutil.h"
+#include "prerror.h"
+#include "stdint.h"
+
+namespace mozilla { namespace pkix { namespace test {
+
+class ResultWithPRErrorCode
+{
+public:
+  ResultWithPRErrorCode(Result rv, PRErrorCode errorCode)
+    : mRv(rv)
+    , mErrorCode(errorCode)
+  {
+  }
+
+  explicit ResultWithPRErrorCode(Result rv)
+    : mRv(rv)
+    , mErrorCode(rv == Success ? 0 : PR_GetError())
+  {
+  }
+
+  bool operator==(const ResultWithPRErrorCode& other) const
+  {
+    return mRv == other.mRv && mErrorCode == other.mErrorCode;
+  }
+
+private:
+  const Result mRv;
+  const PRErrorCode mErrorCode;
+
+  friend std::ostream& operator<<(std::ostream& os,
+                                  const ResultWithPRErrorCode & value);
+
+  void operator=(const ResultWithPRErrorCode&) /*= delete*/;
+};
+
+::std::ostream& operator<<(::std::ostream&, const ResultWithPRErrorCode &);
+
+#define ASSERT_Success(rv) \
+  ASSERT_EQ(::mozilla::pkix::test::ResultWithPRErrorCode( \
+                ::mozilla::pkix::Success, 0), \
+            ::mozilla::pkix::test::ResultWithPRErrorCode(rv))
+#define EXPECT_Success(rv) \
+  EXPECT_EQ(::mozilla::pkix::test::ResultWithPRErrorCode( \
+                ::mozilla::pkix::Success, 0), \
+            ::mozilla::pkix::test::ResultWithPRErrorCode(rv))
+
+#define ASSERT_RecoverableError(expectedError, rv) \
+  ASSERT_EQ(::mozilla::pkix::test::ResultWithPRErrorCode( \
+                 ::mozilla::pkix::RecoverableError, expectedError), \
+            ::mozilla::pkix::test::ResultWithPRErrorCode(rv))
+#define EXPECT_RecoverableError(expectedError, rv) \
+  EXPECT_EQ(::mozilla::pkix::test::ResultWithPRErrorCode( \
+                 ::mozilla::pkix::RecoverableError, expectedError), \
+            ::mozilla::pkix::test::ResultWithPRErrorCode(rv))
+
+#define ASSERT_FatalError(expectedError, rv) \
+  ASSERT_EQ(::mozilla::pkix::test::ResultWithPRErrorCode( \
+                 ::mozilla::pkix::FatalError, expectedError), \
+            ::mozilla::pkix::test::ResultWithPRErrorCode(rv))
+#define EXPECT_FatalError(expectedError, rv) \
+  EXPECT_EQ(::mozilla::pkix::test::ResultWithPRErrorCode( \
+                 ::mozilla::pkix::FatalError, expectedError), \
+            ::mozilla::pkix::test::ResultWithPRErrorCode(rv))
+
+} } } // namespace mozilla::pkix::test
+
+#endif // mozilla_pkix__pkixgtest_h