fune/toolkit/components/url-classifier/tests/gtest/Common.h
Nika Layzell 0316dc51b9 Bug 1790614 - Part 2: Use {ASSERT,ENSURE}_NS_{SUCCEEEDED,FAILED} in gtests, r=ahal,necko-reviewers
These macros will produce better outputs when they fail than these existing
patterns using `ENSURE_TRUE(NS_SUCCEEDED(...))` or similar, so this is a bulk
rewrite of existing tests to use them.

It should also help with discoverability when people base their tests off of
other existing tests.

Differential Revision: https://phabricator.services.mozilla.com/D157214
2022-09-15 14:51:50 +00:00

89 lines
2.9 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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/. */
#ifndef nsUrlClassifierGTestCommon_h__
#define nsUrlClassifierGTestCommon_h__
#include "Entries.h"
#include "nsIFile.h"
#include "nsTArray.h"
#include "gtest/gtest.h"
#include "mozilla/gtest/MozAssertions.h"
using namespace mozilla::safebrowsing;
namespace mozilla {
namespace safebrowsing {
class Classifier;
class LookupCacheV4;
class TableUpdate;
} // namespace safebrowsing
} // namespace mozilla
#define GTEST_TABLE_V4 "gtest-malware-proto"_ns
#define GTEST_TABLE_V2 "gtest-malware-simple"_ns
template <typename Function>
void RunTestInNewThread(Function&& aFunction);
// Synchronously apply updates by calling Classifier::AsyncApplyUpdates.
nsresult SyncApplyUpdates(Classifier* aClassifier,
nsTArray<TableUpdate*>* aUpdates);
// Return nsIFile with root directory - NS_APP_USER_PROFILE_50_DIR
// Sub-directories are passed in path argument.
already_AddRefed<nsIFile> GetFile(const nsTArray<nsString>& aPath);
// ApplyUpdate will call |ApplyUpdates| of Classifier within a new thread
void ApplyUpdate(nsTArray<TableUpdate*>& aUpdates);
void ApplyUpdate(TableUpdate* aUpdate);
/**
* Prefix processing utility functions
*/
typedef nsCString _Prefix;
typedef nsTArray<nsCString> _PrefixArray;
// This function converts a lexigraphic-sorted prefixes array
// to a hash table keyed by prefix size(PrefixStringMap is defined in Entries.h)
nsresult PrefixArrayToPrefixStringMap(const _PrefixArray& aPrefixArray,
PrefixStringMap& aOut);
// This function converts a lexigraphic-sorted prefixes array
// to an array containing AddPrefix(AddPrefix is defined in Entries.h)
nsresult PrefixArrayToAddPrefixArray(const _PrefixArray& aPrefixArray,
AddPrefixArray& aOut);
_Prefix CreatePrefixFromURL(const char* aURL, uint8_t aPrefixSize);
_Prefix CreatePrefixFromURL(const nsCString& aURL, uint8_t aPrefixSize);
// To test if the content is equal
void CheckContent(LookupCacheV4* cache, const _PrefixArray& aPrefixArray);
/**
* Utility function to generate safebrowsing internal structure
*/
// Create a LookupCacheV4 object with sepecified prefix array.
template <typename T>
RefPtr<T> SetupLookupCache(const _PrefixArray& aPrefixArray);
template <typename T>
RefPtr<T> SetupLookupCache(const _PrefixArray& aPrefixArray,
nsCOMPtr<nsIFile>& aFile);
/**
* Retrieve Classifer class
*/
RefPtr<Classifier> GetClassifier();
nsresult BuildLookupCache(const RefPtr<Classifier>& aClassifier,
const nsACString& aTable, _PrefixArray& aPrefixArray);
#endif // nsUrlClassifierGTestCommon_h__