xref: /aosp_15_r20/external/cronet/base/test/gtest_links.h (revision 6777b5387eb2ff775bb5750e3f5d96f37fb7352b)
1*6777b538SAndroid Build Coastguard Worker // Copyright 2020 The Chromium Authors
2*6777b538SAndroid Build Coastguard Worker // Use of this source code is governed by a BSD-style license that can be
3*6777b538SAndroid Build Coastguard Worker // found in the LICENSE file.
4*6777b538SAndroid Build Coastguard Worker 
5*6777b538SAndroid Build Coastguard Worker #ifndef BASE_TEST_GTEST_LINKS_H_
6*6777b538SAndroid Build Coastguard Worker #define BASE_TEST_GTEST_LINKS_H_
7*6777b538SAndroid Build Coastguard Worker 
8*6777b538SAndroid Build Coastguard Worker #include <string>
9*6777b538SAndroid Build Coastguard Worker 
10*6777b538SAndroid Build Coastguard Worker namespace base {
11*6777b538SAndroid Build Coastguard Worker 
12*6777b538SAndroid Build Coastguard Worker // Add a link in the gtest xml output.
13*6777b538SAndroid Build Coastguard Worker // Only call this from a gtest test body with the same thread as the test.
14*6777b538SAndroid Build Coastguard Worker // Only works on desktop.
15*6777b538SAndroid Build Coastguard Worker // A test can call this function when the test generates a link and save it
16*6777b538SAndroid Build Coastguard Worker // as part of the test result.
17*6777b538SAndroid Build Coastguard Worker // Example: AddLinkToTestResult("image_link",
18*6777b538SAndroid Build Coastguard Worker // "https://example_googlestorage/test.png") can mean a test generates an image
19*6777b538SAndroid Build Coastguard Worker // with the url.
20*6777b538SAndroid Build Coastguard Worker // |name| is the link name. It should be unique in one test case. Name will
21*6777b538SAndroid Build Coastguard Worker // be displayed on test result page(Milo). |name| should only contains
22*6777b538SAndroid Build Coastguard Worker // ascii-letters, ascii-digits, '/' and '_'.
23*6777b538SAndroid Build Coastguard Worker // |url| the actual url.
24*6777b538SAndroid Build Coastguard Worker void AddLinkToTestResult(const std::string& name, const std::string& url);
25*6777b538SAndroid Build Coastguard Worker 
26*6777b538SAndroid Build Coastguard Worker }  // namespace base
27*6777b538SAndroid Build Coastguard Worker 
28*6777b538SAndroid Build Coastguard Worker #endif  // BASE_TEST_GTEST_LINKS_H_
29