RTCCertificateStats added.

webrtc/api/rtcstatscollector_unittest.cc

 /*
  *  Copyright 2016 The WebRTC project authors. All Rights Reserved.
  *
  *  Use of this source code is governed by a BSD-style license
  *  that can be found in the LICENSE file in the root of the source
  *  tree. An additional intellectual property rights grant can be found
  *  in the file PATENTS.  All contributing project authors may
  *  be found in the AUTHORS file in the root of the source tree.
  */
 
 #include "webrtc/api/rtcstatscollector.h"
 
 #include <memory>
 #include <string>
 #include <vector>
 
 #include "webrtc/api/jsepsessiondescription.h"
 #include "webrtc/api/stats/rtcstats_objects.h"
 #include "webrtc/api/stats/rtcstatsreport.h"
 #include "webrtc/api/test/mock_datachannel.h"
 #include "webrtc/api/test/mock_peerconnection.h"
 #include "webrtc/api/test/mock_webrtcsession.h"
 #include "webrtc/base/checks.h"
 #include "webrtc/base/fakeclock.h"
+#include "webrtc/base/fakesslidentity.h"
 #include "webrtc/base/gunit.h"
 #include "webrtc/base/logging.h"
 #include "webrtc/base/thread_checker.h"
 #include "webrtc/base/timedelta.h"
 #include "webrtc/base/timeutils.h"
 #include "webrtc/media/base/fakemediaengine.h"
 
+using testing::_;
+using testing::Invoke;
 using testing::Return;
 using testing::ReturnRef;
 
 namespace webrtc {
 
 namespace {
 
 const int64_t kGetStatsReportTimeoutMs = 1000;
 
+struct CertificateInfo {
+  rtc::scoped_refptr<rtc::RTCCertificate> certificate;
+  std::vector<std::string> ders;
+  std::vector<std::string> pems;
+  std::vector<std::string> fingerprints;
+};
+
+std::unique_ptr<CertificateInfo> CreateFakeCertificateAndInfoFromDers(
+    const std::vector<std::string>& ders) {
+  RTC_CHECK(!ders.empty());
+  std::unique_ptr<CertificateInfo> info(new CertificateInfo());
+  info->ders = ders;
+  for (const std::string& der : ders) {
+    info->pems.push_back(rtc::SSLIdentity::DerToPem(
+        "CERTIFICATE",
+        reinterpret_cast<const unsigned char*>(der.c_str()),
+        der.length()));
+  }
+  info->certificate =
+      rtc::RTCCertificate::Create(std::unique_ptr<rtc::FakeSSLIdentity>(
+          new rtc::FakeSSLIdentity(rtc::FakeSSLCertificate(info->pems))));
+  // Strip header/footer and newline characters of PEM strings.
+  for (size_t i = 0; i < info->pems.size(); ++i) {
+    rtc::replace_substrs("-----BEGIN CERTIFICATE-----", 27,
+                         "", 0, &info->pems[i]);
+    rtc::replace_substrs("-----END CERTIFICATE-----", 25,
+                         "", 0, &info->pems[i]);
+    rtc::replace_substrs("\n", 1,
+                         "", 0, &info->pems[i]);
+  }
+  // Fingerprint of leaf certificate.
+  std::unique_ptr<rtc::SSLFingerprint> fp(
+      rtc::SSLFingerprint::Create("sha-1",
+                                  &info->certificate->ssl_certificate()));
+  EXPECT_TRUE(fp);
+  info->fingerprints.push_back(fp->GetRfc4572Fingerprint());
+  // Fingerprints of the rest of the chain.
+  std::unique_ptr<rtc::SSLCertChain> chain =
+      info->certificate->ssl_certificate().GetChain();
+  if (chain) {
+    for (size_t i = 0; i < chain->GetSize(); i++) {
+      fp.reset(rtc::SSLFingerprint::Create("sha-1", &chain->Get(i)));
+      EXPECT_TRUE(fp);
+      info->fingerprints.push_back(fp->GetRfc4572Fingerprint());
+    }
+  }
+  EXPECT_EQ(info->ders.size(), info->fingerprints.size());
+  return info;
+}
+
 class RTCStatsCollectorTestHelper : public SetSessionDescriptionObserver {
  public:
   RTCStatsCollectorTestHelper()
       : worker_thread_(rtc::Thread::Current()),
         network_thread_(rtc::Thread::Current()),
         channel_manager_(new cricket::ChannelManager(
             new cricket::FakeMediaEngine(),
             worker_thread_,
             network_thread_)),
         media_controller_(
             MediaControllerInterface::Create(cricket::MediaConfig(),
                                              worker_thread_,
                                              channel_manager_.get())),
         session_(media_controller_.get()),
         pc_() {
     EXPECT_CALL(pc_, session()).WillRepeatedly(Return(&session_));
     EXPECT_CALL(pc_, sctp_data_channels()).WillRepeatedly(
         ReturnRef(data_channels_));
+    // Default return values for mocks.

[hta-webrtc, 2016/10/03 14:51:36]

Move comment before all the EXPECT_CALL lines?

[hbos, 2016/10/03 15:38:49]

Done.

+    EXPECT_CALL(session_, GetTransportStats(_)).WillRepeatedly(Return(false));
   }
 
   rtc::ScopedFakeClock& fake_clock() { return fake_clock_; }
   MockWebRtcSession& session() { return session_; }
   MockPeerConnection& pc() { return pc_; }
   std::vector<rtc::scoped_refptr<DataChannel>>& data_channels() {
     return data_channels_;
   }
 
   // SetSessionDescriptionObserver overrides.
@@ skipping 177 matching lines @@
           &test_->pc(), 50 * rtc::kNumMicrosecsPerMillisec)) {
   }
 
   rtc::scoped_refptr<const RTCStatsReport> GetStatsReport() {
     rtc::scoped_refptr<StatsCallback> callback = StatsCallback::Create();
     collector_->GetStatsReport(callback);
     EXPECT_TRUE_WAIT(callback->report(), kGetStatsReportTimeoutMs);
     return callback->report();
   }
 
+  void ExpectReportContainsCertificateInfo(
+      const rtc::scoped_refptr<const RTCStatsReport>& report,
+      const CertificateInfo& cert_info) {
+    for (size_t i = 0; i < cert_info.fingerprints.size(); ++i) {
+      const RTCStats* stats = report->Get(
+          "RTCCertificate_" + cert_info.fingerprints[i]);
+      EXPECT_TRUE(stats);
+      const RTCCertificateStats& cert_stats =
+          stats->cast_to<const RTCCertificateStats>();
+      EXPECT_EQ(*cert_stats.fingerprint, cert_info.fingerprints[i]);
+      EXPECT_EQ(*cert_stats.fingerprint_algorithm, "sha-1");
+      EXPECT_EQ(*cert_stats.base64_certificate, cert_info.pems[i]);
+      if (i + 1 < cert_info.fingerprints.size()) {
+        EXPECT_EQ(*cert_stats.issuer_certificate_id,
+                  "RTCCertificate_" + cert_info.fingerprints[i + 1]);
+      } else {
+        EXPECT_FALSE(cert_stats.issuer_certificate_id.is_defined());
+      }
+    }
+  }
+
  protected:
   rtc::scoped_refptr<RTCStatsCollectorTestHelper> test_;
   rtc::scoped_refptr<RTCStatsCollector> collector_;
 };
 
 TEST_F(RTCStatsCollectorTest, SingleCallback) {
   rtc::scoped_refptr<const RTCStatsReport> result;
   collector_->GetStatsReport(StatsCallback::Create(&result));
   EXPECT_TRUE_WAIT(result, kGetStatsReportTimeoutMs);
 }
@@ skipping 39 matching lines @@
   collector_->GetStatsReport(StatsCallback::Create(&c));
   EXPECT_TRUE_WAIT(a, kGetStatsReportTimeoutMs);
   EXPECT_TRUE_WAIT(b, kGetStatsReportTimeoutMs);
   EXPECT_TRUE_WAIT(c, kGetStatsReportTimeoutMs);
   EXPECT_EQ(a.get(), b.get());
   // The act of doing |AdvanceTime| processes all messages. If this was not the
   // case we might not require |c| to be fresher than |b|.
   EXPECT_NE(c.get(), b.get());
 }
 
+TEST_F(RTCStatsCollectorTest, CollectRTCCertificateStatsSingle) {
+  std::unique_ptr<CertificateInfo> local(new CertificateInfo());
+  local->ders.push_back("(local) single certificate");
+  local = CreateFakeCertificateAndInfoFromDers(local->ders);

[hta-webrtc, 2016/10/03 14:51:36]

Here you are creating an unique_ptr with a generic name (local), manipulating
it, and then overwriting it based on itself.
I think it would be more readable if you called it local_certificate and just
wrote to it once, and called the temp that you currently store in |local|
temp_certificate. Similarly for remote below.

You repeat this pattern a number of times, so perhaps a helper function is
indicated?

[hbos, 2016/10/03 15:38:49]

Constructing using a vector instead.

+  std::unique_ptr<CertificateInfo> remote(new CertificateInfo());
+  remote->ders.push_back("(remote) single certificate");
+  remote = CreateFakeCertificateAndInfoFromDers(remote->ders);
+
+  // Mock the session to return the local and remote certificates.
+  EXPECT_CALL(test_->session(), GetTransportStats(_)).WillRepeatedly(Invoke(
+      [this](SessionStats* stats) {
+        stats->transport_stats["transport"].transport_name = "transport";
+        return true;
+      }));
+  EXPECT_CALL(test_->session(), GetLocalCertificate(_, _)).WillRepeatedly(
+      Invoke([this, &local](const std::string& transport_name,
+             rtc::scoped_refptr<rtc::RTCCertificate>* certificate) {
+        if (transport_name == "transport") {
+          *certificate = local->certificate;
+          return true;
+        }
+        return false;
+      }));
+  EXPECT_CALL(test_->session(),
+      GetRemoteSSLCertificate_ReturnsRawPointer(_)).WillRepeatedly(Invoke(
+      [this, &remote](const std::string& transport_name) {
+        if (transport_name == "transport")
+          return remote->certificate->ssl_certificate().GetReference();
+        return static_cast<rtc::SSLCertificate*>(nullptr);
+      }));
+
+  rtc::scoped_refptr<const RTCStatsReport> report = GetStatsReport();
+  ExpectReportContainsCertificateInfo(report, *local.get());
+  ExpectReportContainsCertificateInfo(report, *remote.get());
+}
+
+TEST_F(RTCStatsCollectorTest, CollectRTCCertificateStatsMultiple) {
+  std::unique_ptr<CertificateInfo> audio_local(new CertificateInfo());
+  audio_local->ders.push_back("(local) audio");
+  audio_local = CreateFakeCertificateAndInfoFromDers(audio_local->ders);
+  std::unique_ptr<CertificateInfo> audio_remote(new CertificateInfo());
+  audio_remote->ders.push_back("(remote) audio");
+  audio_remote = CreateFakeCertificateAndInfoFromDers(audio_remote->ders);
+
+  std::unique_ptr<CertificateInfo> video_local(new CertificateInfo());
+  video_local->ders.push_back("(local) video");
+  video_local = CreateFakeCertificateAndInfoFromDers(video_local->ders);
+  std::unique_ptr<CertificateInfo> video_remote(new CertificateInfo());
+  video_remote->ders.push_back("(remote) video");
+  video_remote = CreateFakeCertificateAndInfoFromDers(video_remote->ders);
+
+  // Mock the session to return the local and remote certificates.
+  EXPECT_CALL(test_->session(), GetTransportStats(_)).WillRepeatedly(Invoke(
+      [this](SessionStats* stats) {
+        stats->transport_stats["audio"].transport_name = "audio";
+        stats->transport_stats["video"].transport_name = "video";
+        return true;
+      }));
+  EXPECT_CALL(test_->session(), GetLocalCertificate(_, _)).WillRepeatedly(
+      Invoke([this, &audio_local, &video_local](
+            const std::string& transport_name,
+            rtc::scoped_refptr<rtc::RTCCertificate>* certificate) {
+        if (transport_name == "audio") {
+          *certificate = audio_local->certificate;
+          return true;
+        }
+        if (transport_name == "video") {
+          *certificate = video_local->certificate;
+          return true;
+        }
+        return false;
+      }));
+  EXPECT_CALL(test_->session(),
+      GetRemoteSSLCertificate_ReturnsRawPointer(_)).WillRepeatedly(Invoke(
+      [this, &audio_remote, &video_remote](const std::string& transport_name) {
+        if (transport_name == "audio")
+          return audio_remote->certificate->ssl_certificate().GetReference();
+        if (transport_name == "video")
+          return video_remote->certificate->ssl_certificate().GetReference();
+        return static_cast<rtc::SSLCertificate*>(nullptr);
+      }));
+
+  rtc::scoped_refptr<const RTCStatsReport> report = GetStatsReport();
+  ExpectReportContainsCertificateInfo(report, *audio_local.get());
+  ExpectReportContainsCertificateInfo(report, *audio_remote.get());
+  ExpectReportContainsCertificateInfo(report, *video_local.get());
+  ExpectReportContainsCertificateInfo(report, *video_remote.get());

[hta-webrtc, 2016/10/03 14:51:36]

Good rename. More readable.

[hbos, 2016/10/03 15:38:49]

Acknowledged.

+}
+
+TEST_F(RTCStatsCollectorTest, CollectRTCCertificateStatsChain) {
+  std::unique_ptr<CertificateInfo> local(new CertificateInfo());
+  local->ders.push_back("(local) this");
+  local->ders.push_back("(local) is");
+  local->ders.push_back("(local) a");
+  local->ders.push_back("(local) chain");
+  local = CreateFakeCertificateAndInfoFromDers(local->ders);
+  std::unique_ptr<CertificateInfo> remote(new CertificateInfo());
+  remote->ders.push_back("(remote) this");
+  remote->ders.push_back("(remote) is");
+  remote->ders.push_back("(remote) another");
+  remote->ders.push_back("(remote) chain");
+  remote = CreateFakeCertificateAndInfoFromDers(remote->ders);
+
+  // Mock the session to return the local and remote certificates.
+  EXPECT_CALL(test_->session(), GetTransportStats(_)).WillRepeatedly(Invoke(
+      [this](SessionStats* stats) {
+        stats->transport_stats["transport"].transport_name = "transport";
+        return true;
+      }));
+  EXPECT_CALL(test_->session(), GetLocalCertificate(_, _)).WillRepeatedly(
+      Invoke([this, &local](const std::string& transport_name,
+             rtc::scoped_refptr<rtc::RTCCertificate>* certificate) {
+        if (transport_name == "transport") {
+          *certificate = local->certificate;
+          return true;
+        }
+        return false;
+      }));
+  EXPECT_CALL(test_->session(),
+      GetRemoteSSLCertificate_ReturnsRawPointer(_)).WillRepeatedly(Invoke(
+      [this, &remote](const std::string& transport_name) {
+        if (transport_name == "transport")
+          return remote->certificate->ssl_certificate().GetReference();
+        return static_cast<rtc::SSLCertificate*>(nullptr);
+      }));
+
+  rtc::scoped_refptr<const RTCStatsReport> report = GetStatsReport();
+  ExpectReportContainsCertificateInfo(report, *local.get());
+  ExpectReportContainsCertificateInfo(report, *remote.get());
+}
+
 TEST_F(RTCStatsCollectorTest, CollectRTCPeerConnectionStats) {
   int64_t before = rtc::TimeUTCMicros();
   rtc::scoped_refptr<const RTCStatsReport> report = GetStatsReport();
   int64_t after = rtc::TimeUTCMicros();
   EXPECT_EQ(report->GetStatsOfType<RTCPeerConnectionStats>().size(),
             static_cast<size_t>(1)) << "Expecting 1 RTCPeerConnectionStats.";
   const RTCStats* stats = report->Get("RTCPeerConnection");
   EXPECT_TRUE(stats);
   EXPECT_LE(before, stats->timestamp_us());
   EXPECT_LE(stats->timestamp_us(), after);
@@ skipping 46 matching lines @@
   rtc::scoped_refptr<FakeRTCStatsCollector> collector_;
 };
 
 TEST_F(RTCStatsCollectorTestWithFakeCollector, ThreadUsageAndResultsMerging) {
   collector_->VerifyThreadUsageAndResultsMerging();
 }
 
 }  // namespace
 
 }  // namespace webrtc