File: test_external_cache.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 (123 lines) | stat: -rw-r--r-- 4,909 bytes parent folder | download | duplicates (6)
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_ASH_EXTENSIONS_TEST_EXTERNAL_CACHE_H_
#define CHROME_BROWSER_ASH_EXTENSIONS_TEST_EXTERNAL_CACHE_H_

#include <map>
#include <memory>
#include <set>
#include <string>
#include <vector>

#include "base/memory/raw_ptr.h"
#include "base/values.h"
#include "chrome/browser/ash/extensions/external_cache.h"
#include "extensions/browser/updater/extension_downloader_delegate.h"

namespace chromeos {

class ExternalCacheDelegate;

// External cache implementation to be used in tests - instead of using a
// real local extension cache, which saves cached extension data to disk, it
// keeps cached extension CRX info in memory.
class TestExternalCache : public ExternalCache {
 public:
  TestExternalCache(ExternalCacheDelegate* delegate,
                    bool always_check_for_updates);

  TestExternalCache(const TestExternalCache&) = delete;
  TestExternalCache& operator=(const TestExternalCache&) = delete;

  ~TestExternalCache() override;

  // ExternalCache:
  const base::Value::Dict& GetCachedExtensions() override;
  void Shutdown(base::OnceClosure callback) override;
  void UpdateExtensionsList(base::Value::Dict prefs) override;
  void OnDamagedFileDetected(const base::FilePath& path) override;
  void RemoveExtensions(const std::vector<std::string>& ids) override;
  bool GetExtension(const std::string& id,
                    base::FilePath* file_path,
                    std::string* version) override;
  bool ExtensionFetchPending(const std::string& id) override;
  void PutExternalExtension(const std::string& id,
                            const base::FilePath& crx_file_path,
                            const std::string& version,
                            PutExternalExtensionCallback callback) override;
  void SetBackoffPolicy(
      std::optional<net::BackoffEntry::Policy> new_backoff_policy) override;

  // Simulates extension CRX download succeeding - it adds the extension
  // information to |cache_|.
  // |id| - the "downloaded" extension ID.
  // |crx_path| - the path to which the CRX is "downloaded".
  // |version| - the "downloaded" extension version.
  // |is_update| - whether the CRX download is started by extension update.
  // Returns whether the extension information has actually been saved. This
  // will return false if the cache does not think that the extension's
  // downaload is pending.
  bool SimulateExtensionDownloadFinished(const std::string& id,
                                         const std::string& crx_path,
                                         const std::string& version,
                                         bool is_update);

  // Simulates the extension's download failure. This will remove the extension
  // info from the set of extensions tracked in this external cache.
  // Returns whether the extension information has actually been changed. This
  // will return false if the cache does not think that the extension's
  // downaload is pending.
  bool SimulateExtensionDownloadFailed(
      const std::string& id,
      extensions::ExtensionDownloaderDelegate::Error error);

  // Set of the extension IDs in download pending state. Note that |this| does
  // not actually initiate the download, the user is expected to call either
  // SimulateExtensionDownloadFinished(), or SimulateExtensionDownloadFailed()
  // in order to remove an extension from this state and update the extension's
  // CRX information tracked by the external cache.
  const std::set<std::string>& pending_downloads() const {
    return pending_downloads_;
  }

  const std::optional<net::BackoffEntry::Policy>& backoff_policy() const {
    return backoff_policy_;
  }

 private:
  // An extension CRX information tracked by |this|.
  struct CrxCacheEntry {
    // The extension CRX path.
    std::string path;

    // The extension version associtated with the extension CRX.
    std::string version;
  };

  // Updates locally tracked state - called when the set of
  // |configured_extensions_| changes. It updates |cached_extensions_| and
  // adds extensions to |pending_downloads_| as needed.
  void UpdateCachedExtensions();

  // Adds an extension's CRX information to |crx_cache_|.
  void AddEntryToCrxCache(const std::string& id,
                          const std::string& crx_path,
                          const std::string& version);

  const raw_ptr<ExternalCacheDelegate> delegate_;
  const bool always_check_for_updates_;

  std::optional<net::BackoffEntry::Policy> backoff_policy_;

  base::Value::Dict configured_extensions_;
  base::Value::Dict cached_extensions_;

  std::set<std::string> pending_downloads_;
  std::map<std::string, CrxCacheEntry> crx_cache_;
};

}  // namespace chromeos

#endif  // CHROME_BROWSER_ASH_EXTENSIONS_TEST_EXTERNAL_CACHE_H_