File: clustering_test_utils.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (74 lines) | stat: -rw-r--r-- 2,560 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_HISTORY_CLUSTERS_CORE_CLUSTERING_TEST_UTILS_H_
#define COMPONENTS_HISTORY_CLUSTERS_CORE_CLUSTERING_TEST_UTILS_H_

#include <cstdint>
#include <ostream>
#include <vector>

#include "base/time/time.h"
#include "components/history/core/browser/history_types.h"

namespace history_clusters::testing {

// A helper object that contains the elements to validate that
// the result visits of clusters are correct.
class VisitResult {
 public:
  VisitResult(
      int visit_id,
      float score,
      const std::vector<history::DuplicateClusterVisit>& duplicate_visits = {},
      std::u16string search_terms = u"");
  explicit VisitResult(const history::ClusterVisit& visit);
  VisitResult(const VisitResult& other);
  ~VisitResult();

  bool operator==(const VisitResult& rhs) const;

  std::string ToString() const;

 private:
  friend std::ostream& operator<<(std::ostream& os, const VisitResult& dt);

  const int visit_id_;
  const float score_;
  std::vector<history::DuplicateClusterVisit> duplicate_visits_;
  const std::u16string search_terms_;
};

std::ostream& operator<<(std::ostream& os, const VisitResult& dt);

// Converts |clusters| to VisitResults which are easier to test equality for.
std::vector<std::vector<testing::VisitResult>> ToVisitResults(
    const std::vector<history::Cluster>& clusters);

// Creates a default AnnotatedVisit that has the minimal set of fields required.
history::AnnotatedVisit CreateDefaultAnnotatedVisit(
    int visit_id,
    const GURL& url,
    base::Time visit_time = base::Time());

// Creates a ClusterVisit from |annotated_visit|. Will populate the returned
// ClusterVisit's normalized_url with |normalized_url| if present but otherwise
// will use the URL contained in the AnnotatedVisit.
history::ClusterVisit CreateClusterVisit(
    const history::AnnotatedVisit& annotated_visit,
    std::optional<GURL> normalized_url = std::nullopt,
    float score = 1.0,
    history::ClusterVisit::InteractionState interaction_state =
        history::ClusterVisit::InteractionState::kDefault);

history::DuplicateClusterVisit ClusterVisitToDuplicateClusterVisit(
    history::ClusterVisit cluster_visit);

// Creates a Cluster from |cluster_visits|.
history::Cluster CreateCluster(
    std::vector<history::ClusterVisit>& cluster_visits);

}  // namespace history_clusters::testing

#endif  // COMPONENTS_HISTORY_CLUSTERS_CORE_CLUSTERING_TEST_UTILS_H_