File: google_storage_helper_test.py

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 (168 lines) | stat: -rwxr-xr-x 5,997 bytes parent folder | download | duplicates (5)
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
#!/usr/bin/env vpython3
# Copyright 2025 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Unittest for google_storage_helper.py.

Example usage:
  vpython3 google_storage_helper_test.py
"""

import os
import sys
import time
import unittest
from unittest import mock

import google_storage_helper as helper  # pylint: disable=import-error
from parameterized import parameterized  # pylint: disable=import-error

LIB_PATH = os.path.join(os.path.dirname(__file__), os.pardir, os.pardir)
sys.path.append(LIB_PATH)

DIR_SOURCE_ROOT = os.environ.get(
    'CHECKOUT_SOURCE_ROOT',
    os.path.abspath(
        os.path.join(os.path.dirname(__file__), os.pardir, os.pardir, os.pardir,
                     os.pardir)))
DEVIL_PATH = os.path.join(DIR_SOURCE_ROOT, 'third_party', 'catapult', 'devil')

if DEVIL_PATH not in sys.path:
  sys.path.append(DEVIL_PATH)
from devil.utils import cmd_helper


class GoogleStorageHelperTest(unittest.TestCase):

  @parameterized.expand([
      (
          'empty_bucket_name',
          '',
          '',
      ),
      (
          'bucket_name_with_gs',
          'gs://foo/bar',
          'foo/bar',
      ),
      (
          'bucket_name_with_gs_end_slash',
          'gs://foo/bar/',
          'foo/bar',
      ),
      (
          'bucket_name_no_gs',
          'foo/bar',
          'foo/bar',
      ),
      (
          'bucket_name_no_gs_end_slash',
          'gs://foo/bar/',
          'foo/bar',
      ),
  ])
  def test_format_bucket_name(self, _, bucket, expected):
    got = helper._format_bucket_name(bucket)  # pylint: disable=protected-access
    self.assertEqual(
        got,
        expected,
    )

  @mock.patch('platform.system', autospec=True)
  @mock.patch.object(cmd_helper, 'RunCmd', autospec=True)
  def test_exists(self, mock_cmd_helper, mock_system):
    bucket = 'foo'
    name = 'bar'
    with self.subTest(name='Windows'):
      with mock.patch.object(helper,
                             'get_gsutil_script_path',
                             autospec=True,
                             return_value='path_to_gsutil_py'):
        mock_system.return_value = 'Windows'
        helper.exists(name, bucket)
        mock_cmd_helper.assert_called_once_with(
            ['path_to_gsutil_py', '-q', 'stat', 'gs://foo/bar'])
    mock_cmd_helper.reset_mock()
    with self.subTest(name='Linux'):
      with mock.patch.object(helper,
                             'get_gsutil_script_path',
                             autospec=True,
                             return_value='path_to_gsutil'):
        mock_system.return_value = 'Linux'
        helper.exists(name, bucket)
        mock_cmd_helper.assert_called_once_with(
            ['path_to_gsutil', '-q', 'stat', 'gs://foo/bar'])

  @mock.patch('platform.system', autospec=True)
  @mock.patch.object(cmd_helper, 'RunCmd', autospec=True)
  @mock.patch.object(helper, 'get_url_link', autospec=True)
  def test_upload(self, mock_get_url_link, mock_cmd_helper, mock_system):
    bucket = 'foo'
    name = 'bar'
    filepath = os.path.join('abc', 'def.json')
    with self.subTest(name='Windows'):
      with mock.patch.object(helper,
                             'get_gsutil_script_path',
                             autospec=True,
                             return_value='path_to_gsutil_py'):
        mock_system.return_value = 'Windows'
        helper.upload(name, filepath, bucket)
        mock_cmd_helper.assert_called_once_with([
            'path_to_gsutil_py', '-q', 'cp',
            os.path.join('abc', 'def.json'), 'gs://foo/bar'
        ])
        mock_get_url_link.assert_called_once_with(name, bucket, True)
    mock_cmd_helper.reset_mock()
    mock_get_url_link.reset_mock()
    with self.subTest(name='Linux'):
      with mock.patch.object(helper,
                             'get_gsutil_script_path',
                             autospec=True,
                             return_value='path_to_gsutil'):
        mock_system.return_value = 'Linux'
        helper.upload(name, filepath, bucket)
        mock_cmd_helper.assert_called_once_with([
            'path_to_gsutil', '-q', 'cp',
            os.path.join('abc', 'def.json'), 'gs://foo/bar'
        ])
        mock_get_url_link.assert_called_once_with(name, bucket, True)

  @parameterized.expand([
      ('empty_bucket_name', '', 'bar', 'https://storage.cloud.google.com//bar'),
      ('empty_name', 'foo', '', 'https://storage.cloud.google.com/foo/'),
      ('normal', 'foo', 'bar', 'https://storage.cloud.google.com/foo/bar')
  ])
  def test_get_url_link(self, _, bucket, name, expected):
    got = helper.get_url_link(name, bucket, True)
    self.assertEqual(expected, got)

  @mock.patch('time.gmtime')
  def test_unique_name(self, mock_gmtime):
    basename = 'foo'
    suffix = '.json'
    expected = 'foo_2026_01_15_T12_30_00-UTC.json'
    mock_gmtime.return_value = time.struct_time(
        (2026, 1, 15, 12, 30, 0, 3, 15, 0))
    got = helper.unique_name(basename, suffix)
    self.assertEqual(expected, got)

  @parameterized.expand([
      ('empty_link', '', ['path_to_gsutil', '-q', 'cat', 'gs://']),
      ('valid gs_link', '/foo', ['path_to_gsutil', '-q', 'cat', 'gs://foo']),
      ('no_initial_slash', 'foo/bar',
       ['path_to_gsutil', '-q', 'cat', 'gs://foo/bar'])
  ])  # pylint: disable=no-self-use
  def test_read_from_link(self, _, link, expected_sequence):
    with mock.patch('platform.system', autospec=True, return_value='Linux'):
      with mock.patch.object(helper,
                             'get_gsutil_script_path',
                             autospec=True,
                             return_value='path_to_gsutil'):
        with mock.patch.object(cmd_helper, 'GetCmdOutput',
                               autospec=True) as mock_get_cmd_output:
          helper.read_from_link(link)
          mock_get_cmd_output.assert_called_once_with(expected_sequence)


if __name__ == '__main__':
  unittest.main()