Rob Mohr | 3b7da06 | 2020-04-30 14:30:57 -0700 | [diff] [blame] | 1 | # Copyright 2020 The Pigweed Authors |
Rob Mohr | b671bc7 | 2019-12-13 08:36:15 -0800 | [diff] [blame] | 2 | # |
| 3 | # Licensed under the Apache License, Version 2.0 (the "License"); you may not |
| 4 | # use this file except in compliance with the License. You may obtain a copy of |
| 5 | # the License at |
| 6 | # |
| 7 | # https://www.apache.org/licenses/LICENSE-2.0 |
| 8 | # |
| 9 | # Unless required by applicable law or agreed to in writing, software |
| 10 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 11 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 12 | # License for the specific language governing permissions and limitations under |
| 13 | # the License. |
| 14 | """Environment utility functions. |
| 15 | |
| 16 | Usage: |
Rob Mohr | 500364a | 2023-02-01 15:05:30 +0000 | [diff] [blame] | 17 | env = api.environment.initialize(checkout, env_options) |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 18 | with env(): |
Rob Mohr | b671bc7 | 2019-12-13 08:36:15 -0800 | [diff] [blame] | 19 | ... |
| 20 | """ |
| 21 | |
Rob Mohr | 21f15eb | 2020-09-09 10:10:39 -0700 | [diff] [blame] | 22 | import contextlib |
Rob Mohr | 465feb3 | 2023-07-27 01:15:24 +0000 | [diff] [blame] | 23 | import dataclasses |
Rob Mohr | 59a9b1a | 2020-11-10 14:49:43 -0800 | [diff] [blame] | 24 | import pprint |
Rob Mohr | 465feb3 | 2023-07-27 01:15:24 +0000 | [diff] [blame] | 25 | from typing import Any, Dict |
Rob Mohr | 21f15eb | 2020-09-09 10:10:39 -0700 | [diff] [blame] | 26 | |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 27 | from PB.recipe_modules.pigweed.environment.options import Options |
| 28 | |
Rob Mohr | b671bc7 | 2019-12-13 08:36:15 -0800 | [diff] [blame] | 29 | import attr |
Rob Mohr | 465feb3 | 2023-07-27 01:15:24 +0000 | [diff] [blame] | 30 | from recipe_engine import config_types, recipe_api |
Rob Mohr | b671bc7 | 2019-12-13 08:36:15 -0800 | [diff] [blame] | 31 | |
| 32 | |
Rob Mohr | 465feb3 | 2023-07-27 01:15:24 +0000 | [diff] [blame] | 33 | @dataclasses.dataclass |
Rob Mohr | 82c0e35 | 2022-07-27 20:57:40 +0000 | [diff] [blame] | 34 | class Environment: |
Rob Mohr | 465feb3 | 2023-07-27 01:15:24 +0000 | [diff] [blame] | 35 | api: Any |
| 36 | dir: config_types.Path |
| 37 | checkout: Any |
| 38 | prefixes: Dict = dataclasses.field(default_factory=dict) |
| 39 | suffixes: Dict = dataclasses.field(default_factory=dict) |
| 40 | env: Dict = dataclasses.field(default_factory=dict) |
| 41 | override_gn_args: Dict = dataclasses.field(default_factory=dict) |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 42 | |
| 43 | @contextlib.contextmanager |
| 44 | def __call__(self): |
| 45 | # Using reversed() because things that are added later in environment |
| 46 | # setup need to override things that came earlier. |
Rob Mohr | 465feb3 | 2023-07-27 01:15:24 +0000 | [diff] [blame] | 47 | with self.api.context( |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 48 | env_prefixes={k: reversed(v) for k, v in self.prefixes.items()}, |
| 49 | env_suffixes=self.suffixes, |
| 50 | env=self.env, |
| 51 | ): |
Rob Mohr | 465feb3 | 2023-07-27 01:15:24 +0000 | [diff] [blame] | 52 | with self.api.macos_sdk(): |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 53 | yield self |
| 54 | |
| 55 | def __getattr__(self, name): |
| 56 | if name not in self.env: |
| 57 | raise AttributeError(name) |
| 58 | |
| 59 | return self.env.get(name) |
Rob Mohr | b671bc7 | 2019-12-13 08:36:15 -0800 | [diff] [blame] | 60 | |
| 61 | |
| 62 | class EnvironmentApi(recipe_api.RecipeApi): |
Rob Mohr | 5720460 | 2020-09-23 08:41:18 -0700 | [diff] [blame] | 63 | """Environment utility functions.""" |
Rob Mohr | b671bc7 | 2019-12-13 08:36:15 -0800 | [diff] [blame] | 64 | |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 65 | def _init_platform(self, env): |
Rob Mohr | 5720460 | 2020-09-23 08:41:18 -0700 | [diff] [blame] | 66 | if self.m.platform.is_mac: |
| 67 | with self.m.step.nest('setup platform'): |
| 68 | with self.m.macos_sdk(): |
| 69 | pass |
Rob Mohr | 21f15eb | 2020-09-09 10:10:39 -0700 | [diff] [blame] | 70 | |
Rob Mohr | 9a39718 | 2022-07-12 02:00:24 +0000 | [diff] [blame] | 71 | def _init_misc_vars(self, env, additional_variables=None): |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 72 | env.env['PW_ENVIRONMENT_NO_ERROR_ON_UNRECOGNIZED'] = '1' |
| 73 | env.env['PW_ENVSETUP_DISABLE_SPINNER'] = '1' |
| 74 | env.env['PW_PRESUBMIT_DISABLE_SUBPROCESS_CAPTURE'] = '1' |
Rob Mohr | 33bf5df | 2023-03-27 22:24:15 +0000 | [diff] [blame] | 75 | env.env['PW_USE_COLOR'] = '' |
Rob Mohr | e440a9d | 2023-05-17 23:05:48 +0000 | [diff] [blame] | 76 | env.env['CLICOLOR'] = '0' # See https://bixense.com/clicolors/. |
Rob Mohr | 8360e16 | 2021-01-13 08:46:28 -0800 | [diff] [blame] | 77 | |
Rob Mohr | 9a39718 | 2022-07-12 02:00:24 +0000 | [diff] [blame] | 78 | env.env.update(additional_variables or {}) |
| 79 | |
Rob Mohr | a89b6ae | 2020-10-08 13:42:56 -0700 | [diff] [blame] | 80 | if self.m.led.launched_by_led: |
Rob Mohr | e181c02 | 2022-09-16 18:11:17 +0000 | [diff] [blame] | 81 | # Not using self.m.buildbucket_util.id because some downstream |
| 82 | # projects need this id to never be longer than a typical |
| 83 | # buildbucket id. Shorter is fine. |
| 84 | env.env['BUILDBUCKET_ID'] = '0' |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 85 | env.env['BUILD_NUMBER'] = str(self.m.buildbucket.build.number) |
Rob Mohr | 6042b34 | 2020-10-22 16:33:40 -0700 | [diff] [blame] | 86 | |
Rob Mohr | a89b6ae | 2020-10-08 13:42:56 -0700 | [diff] [blame] | 87 | else: |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 88 | env.env['BUILDBUCKET_ID'] = str(self.m.buildbucket.build.id) |
| 89 | env.env['BUILD_NUMBER'] = str(self.m.buildbucket.build.number) |
Rob Mohr | a89b6ae | 2020-10-08 13:42:56 -0700 | [diff] [blame] | 90 | |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 91 | env.env['BUILDBUCKET_NAME'] = ':'.join( |
Rob Mohr | 7ab2baf | 2020-10-16 11:48:29 -0700 | [diff] [blame] | 92 | ( |
| 93 | self.m.buildbucket.build.builder.project, |
| 94 | self.m.buildbucket.build.builder.bucket, |
| 95 | self.m.buildbucket.build.builder.builder, |
| 96 | ) |
| 97 | ) |
Rob Mohr | a89b6ae | 2020-10-08 13:42:56 -0700 | [diff] [blame] | 98 | |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 99 | if env.env['BUILDBUCKET_NAME'] == '::': |
| 100 | env.env['BUILDBUCKET_NAME'] = 'project:bucket:builder' |
Rob Mohr | a89b6ae | 2020-10-08 13:42:56 -0700 | [diff] [blame] | 101 | |
Rob Mohr | fabf49c | 2023-04-11 20:08:52 +0000 | [diff] [blame] | 102 | env.env['CTCACHE_DIR'] = self.m.path['cache'] / 'clang_tidy' |
| 103 | env.env['GOCACHE'] = self.m.path['cache'] / 'go' |
| 104 | env.env['PIP_CACHE_DIR'] = self.m.path['cache'] / 'pip' |
| 105 | env.env['TEST_TMPDIR'] = self.m.path['cache'] / 'bazel' |
Rob Mohr | 59a9b1a | 2020-11-10 14:49:43 -0800 | [diff] [blame] | 106 | |
Rob Mohr | b2d926c | 2023-02-01 15:07:42 +0000 | [diff] [blame] | 107 | env.env['TRIGGERING_CHANGES_JSON'] = env.checkout.changes_json |
| 108 | |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 109 | def _init_pigweed( |
| 110 | self, |
Rob Mohr | 500364a | 2023-02-01 15:05:30 +0000 | [diff] [blame] | 111 | checkout, |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 112 | top_presentation, |
| 113 | use_constraint_file, |
| 114 | pigweed_root, |
Rob Mohr | 9794dc8 | 2023-07-22 00:19:43 +0000 | [diff] [blame] | 115 | options, |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 116 | env, |
| 117 | ): |
Rob Mohr | 59a9b1a | 2020-11-10 14:49:43 -0800 | [diff] [blame] | 118 | """Run pw_env_setup.""" |
| 119 | |
Rob Mohr | 59a9b1a | 2020-11-10 14:49:43 -0800 | [diff] [blame] | 120 | def path(relative_path): |
| 121 | parts = [ |
| 122 | x for x in relative_path.split('/') if x not in ('.', u'.') |
| 123 | ] |
| 124 | if parts: |
Rob Mohr | 500364a | 2023-02-01 15:05:30 +0000 | [diff] [blame] | 125 | return checkout.root.join(*parts) |
Rob Mohr | 59a9b1a | 2020-11-10 14:49:43 -0800 | [diff] [blame] | 126 | else: |
Rob Mohr | 500364a | 2023-02-01 15:05:30 +0000 | [diff] [blame] | 127 | return checkout.root # pragma: no cover |
Rob Mohr | 59a9b1a | 2020-11-10 14:49:43 -0800 | [diff] [blame] | 128 | |
Rob Mohr | fabf49c | 2023-04-11 20:08:52 +0000 | [diff] [blame] | 129 | json_file = env.dir / 'vars.json' |
| 130 | shell_file = env.dir / 'setup.sh' |
| 131 | venv_dir = env.dir / 'venv' |
Rob Mohr | 59a9b1a | 2020-11-10 14:49:43 -0800 | [diff] [blame] | 132 | |
Rob Mohr | 8afb1b4 | 2021-02-26 13:56:08 -0800 | [diff] [blame] | 133 | self.m.file.ensure_directory( |
Rob Mohr | 4806b6b | 2023-02-03 18:03:32 +0000 | [diff] [blame] | 134 | f'mkdir {self.m.path.basename(env.dir)}', env.dir, |
Rob Mohr | 8afb1b4 | 2021-02-26 13:56:08 -0800 | [diff] [blame] | 135 | ) |
Rob Mohr | 59a9b1a | 2020-11-10 14:49:43 -0800 | [diff] [blame] | 136 | |
Rob Mohr | 8afb1b4 | 2021-02-26 13:56:08 -0800 | [diff] [blame] | 137 | self.m.file.ensure_directory( |
Rob Mohr | 4806b6b | 2023-02-03 18:03:32 +0000 | [diff] [blame] | 138 | f'mkdir {self.m.path.basename(venv_dir)}', venv_dir, |
Rob Mohr | 8afb1b4 | 2021-02-26 13:56:08 -0800 | [diff] [blame] | 139 | ) |
Rob Mohr | 59a9b1a | 2020-11-10 14:49:43 -0800 | [diff] [blame] | 140 | |
Rob Mohr | 8afb1b4 | 2021-02-26 13:56:08 -0800 | [diff] [blame] | 141 | cmd = [ |
Rob Mohr | c7e0639 | 2021-04-15 14:10:28 -0700 | [diff] [blame] | 142 | 'python3', |
Rob Mohr | fabf49c | 2023-04-11 20:08:52 +0000 | [diff] [blame] | 143 | ( |
| 144 | pigweed_root |
| 145 | / 'pw_env_setup' |
| 146 | / 'py' |
| 147 | / 'pw_env_setup' |
| 148 | / 'env_setup.py' |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 149 | ), |
Rob Mohr | 8afb1b4 | 2021-02-26 13:56:08 -0800 | [diff] [blame] | 150 | '--pw-root', |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 151 | pigweed_root, |
Rob Mohr | 8afb1b4 | 2021-02-26 13:56:08 -0800 | [diff] [blame] | 152 | '--install-dir', |
Rob Mohr | dcc61c8 | 2022-08-16 18:01:54 +0000 | [diff] [blame] | 153 | env.dir, |
Rob Mohr | 8afb1b4 | 2021-02-26 13:56:08 -0800 | [diff] [blame] | 154 | '--json-file', |
| 155 | json_file, |
| 156 | '--shell-file', |
| 157 | shell_file, |
Rob Mohr | 21e3da8 | 2021-05-27 13:21:41 -0700 | [diff] [blame] | 158 | '--virtualenv-gn-out-dir', |
Rob Mohr | fabf49c | 2023-04-11 20:08:52 +0000 | [diff] [blame] | 159 | env.dir / 'out', |
Rob Mohr | 47d3d5c | 2021-05-13 06:59:23 -0700 | [diff] [blame] | 160 | '--use-existing-cipd', |
Rob Mohr | 95ab034 | 2021-05-27 10:38:22 -0700 | [diff] [blame] | 161 | '--strict', |
Rob Mohr | 8afb1b4 | 2021-02-26 13:56:08 -0800 | [diff] [blame] | 162 | ] |
Rob Mohr | 59a9b1a | 2020-11-10 14:49:43 -0800 | [diff] [blame] | 163 | |
Rob Mohr | 9794dc8 | 2023-07-22 00:19:43 +0000 | [diff] [blame] | 164 | if options.skip_submodule_check: |
Rob Mohr | 5b95c71 | 2022-06-13 13:22:21 -0700 | [diff] [blame] | 165 | cmd.append('--skip-submodule-check') |
| 166 | |
Rob Mohr | 8040819 | 2021-09-23 07:59:12 -0700 | [diff] [blame] | 167 | if not use_constraint_file: |
| 168 | cmd.append('--unpin-pip-packages') |
| 169 | |
Rob Mohr | 3534bfe | 2023-07-24 19:02:55 +0000 | [diff] [blame] | 170 | for f in options.additional_cipd_files: |
Rob Mohr | e403173 | 2023-09-18 22:53:36 +0000 | [diff] [blame^] | 171 | f = f.replace('$PW_ROOT', str(pigweed_root)) |
Rob Mohr | 3534bfe | 2023-07-24 19:02:55 +0000 | [diff] [blame] | 172 | cmd.extend(('--additional-cipd-file', f)) |
| 173 | |
Rob Mohr | 36fd463 | 2023-09-18 16:39:24 +0000 | [diff] [blame] | 174 | cmd.extend( |
| 175 | ('--config-file', path(options.config_file or 'pigweed.json')) |
| 176 | ) |
Rob Mohr | 1889314 | 2021-02-26 07:26:49 -0800 | [diff] [blame] | 177 | |
Rob Mohr | 4e7bea6 | 2022-07-28 14:19:31 +0000 | [diff] [blame] | 178 | top_presentation.logs['config.json'] = pprint.pformat( |
Rob Mohr | 9794dc8 | 2023-07-22 00:19:43 +0000 | [diff] [blame] | 179 | self.m.file.read_json('read config', path(options.config_file)) |
Rob Mohr | 001b8a7 | 2021-06-16 09:22:58 -0700 | [diff] [blame] | 180 | ) |
Rob Mohr | 8afb1b4 | 2021-02-26 13:56:08 -0800 | [diff] [blame] | 181 | |
| 182 | with self.m.step.defer_results(): |
Rob Mohr | 78f5182 | 2023-06-06 18:54:08 +0000 | [diff] [blame] | 183 | with self.m.step.nest('run pw_env_setup') as pres: |
Rob Mohr | 4a778e3 | 2022-09-28 15:05:54 +0000 | [diff] [blame] | 184 | with env(), self.m.default_timeout(): |
Rob Mohr | 8afb1b4 | 2021-02-26 13:56:08 -0800 | [diff] [blame] | 185 | self.m.step('pw_env_setup', cmd) |
| 186 | |
Rob Mohr | 9a0d6af | 2023-04-28 20:30:45 +0000 | [diff] [blame] | 187 | self.m.file.listdir('ls', env.dir, recursive=True).get_result() |
| 188 | |
Rob Mohr | 78f5182 | 2023-06-06 18:54:08 +0000 | [diff] [blame] | 189 | self.m.save_logs((env.dir,), pres=pres) |
Rob Mohr | 59a9b1a | 2020-11-10 14:49:43 -0800 | [diff] [blame] | 190 | |
Rob Mohr | 8afb1b4 | 2021-02-26 13:56:08 -0800 | [diff] [blame] | 191 | json_data = self.m.file.read_json( |
| 192 | 'read json file', |
| 193 | json_file, |
| 194 | test_data={ |
| 195 | 'set': {'VIRTUAL_ENV': '/environment/virtualenv'}, |
| 196 | 'modify': { |
| 197 | 'PATH': {'append': ['/environment/bin']}, |
| 198 | 'LD_LIBRARY_PATH': {'prepend': ['/environment/lib']}, |
Rob Mohr | 59a9b1a | 2020-11-10 14:49:43 -0800 | [diff] [blame] | 199 | }, |
Rob Mohr | 8afb1b4 | 2021-02-26 13:56:08 -0800 | [diff] [blame] | 200 | }, |
| 201 | ) |
Rob Mohr | b1eff26 | 2022-09-07 16:58:47 +0000 | [diff] [blame] | 202 | top_presentation.logs['vars.json'] = pprint.pformat(json_data) |
Rob Mohr | 59a9b1a | 2020-11-10 14:49:43 -0800 | [diff] [blame] | 203 | |
Rob Mohr | fabf49c | 2023-04-11 20:08:52 +0000 | [diff] [blame] | 204 | env_gni_path = ( |
| 205 | checkout.root / 'build_overrides' / 'pigweed_environment.gni' |
Rob Mohr | 0731445 | 2022-08-16 18:22:52 +0000 | [diff] [blame] | 206 | ) |
Rob Mohr | 0731445 | 2022-08-16 18:22:52 +0000 | [diff] [blame] | 207 | |
Rob Mohr | b1eff26 | 2022-09-07 16:58:47 +0000 | [diff] [blame] | 208 | self.m.path.mock_add_file(env_gni_path) |
| 209 | if self.m.path.isfile(env_gni_path): |
| 210 | environment_gni = self.m.file.read_text( |
| 211 | 'read gni file', env_gni_path |
| 212 | ) |
| 213 | top_presentation.logs['pigweed_environment.gni'] = environment_gni |
Rob Mohr | 59a9b1a | 2020-11-10 14:49:43 -0800 | [diff] [blame] | 214 | |
Rob Mohr | e3be66a | 2021-08-27 12:38:18 -0700 | [diff] [blame] | 215 | for var, value in json_data['set'].items(): |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 216 | env.env[var] = value |
Rob Mohr | 59a9b1a | 2020-11-10 14:49:43 -0800 | [diff] [blame] | 217 | |
Rob Mohr | e3be66a | 2021-08-27 12:38:18 -0700 | [diff] [blame] | 218 | for var, actions in json_data['modify'].items(): |
Rob Mohr | 8afb1b4 | 2021-02-26 13:56:08 -0800 | [diff] [blame] | 219 | for value in actions.get('prepend', ()): |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 220 | env.prefixes.setdefault(var, []) |
| 221 | env.prefixes[var].append(value) |
Rob Mohr | 8afb1b4 | 2021-02-26 13:56:08 -0800 | [diff] [blame] | 222 | for value in actions.get('append', ()): |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 223 | env.suffixes.setdefault(var, []) |
| 224 | env.suffixes[var].append(value) |
Rob Mohr | 59a9b1a | 2020-11-10 14:49:43 -0800 | [diff] [blame] | 225 | |
Rob Mohr | dc93dd9 | 2022-08-13 00:15:04 +0000 | [diff] [blame] | 226 | def _toolchain_override(self, env): |
| 227 | """Checks for a toolchain override and applies it.""" |
| 228 | |
| 229 | # Using '$fuchsia/build' properties to simplify interface with the |
| 230 | # Fuchsia Toolchain team. |
| 231 | fuchsia_build_props = self.m.properties.thaw().get('$fuchsia/build', {}) |
| 232 | toolchain_props = fuchsia_build_props.get('clang_toolchain', {}) |
| 233 | if not toolchain_props: |
| 234 | return |
| 235 | |
| 236 | with self.m.step.nest('toolchain override'): |
| 237 | with self.m.context(infra_steps=True): |
Rob Mohr | fabf49c | 2023-04-11 20:08:52 +0000 | [diff] [blame] | 238 | toolchain_dir = env.dir / 'override' / 'clang_toolchain' |
Rob Mohr | dc93dd9 | 2022-08-13 00:15:04 +0000 | [diff] [blame] | 239 | |
| 240 | if toolchain_props['source'] == 'cipd': |
| 241 | pkgs = self.m.cipd.EnsureFile() |
| 242 | pkgs.add_package( |
| 243 | 'fuchsia/third_party/clang/${platform}', |
| 244 | toolchain_props['version'], |
| 245 | ) |
Rob Mohr | bf73221 | 2022-09-12 18:11:22 +0000 | [diff] [blame] | 246 | self.m.cipd.ensure(toolchain_dir, pkgs) |
Rob Mohr | dc93dd9 | 2022-08-13 00:15:04 +0000 | [diff] [blame] | 247 | |
| 248 | elif toolchain_props['source'] in 'isolated': |
Rob Mohr | 6da5ed8 | 2022-09-12 18:20:29 +0000 | [diff] [blame] | 249 | with self.m.cas.with_instance( |
| 250 | 'projects/chromium-swarm/instances/default_instance' |
| 251 | ): |
| 252 | self.m.cas.download( |
| 253 | 'download', |
| 254 | digest=toolchain_props['version'], |
| 255 | output_dir=toolchain_dir, |
| 256 | ) |
Rob Mohr | dc93dd9 | 2022-08-13 00:15:04 +0000 | [diff] [blame] | 257 | |
| 258 | else: # pragma: no cover |
| 259 | raise KeyError( |
| 260 | f'clang toolchain source {toolchain_props["source"]} ' |
| 261 | 'not recognized' |
| 262 | ) |
| 263 | |
| 264 | env.prefixes.setdefault('PATH', []) |
Rob Mohr | bf73221 | 2022-09-12 18:11:22 +0000 | [diff] [blame] | 265 | env.prefixes['PATH'].append(toolchain_dir) |
Rob Mohr | fabf49c | 2023-04-11 20:08:52 +0000 | [diff] [blame] | 266 | env.prefixes['PATH'].append(toolchain_dir / 'bin') |
Rob Mohr | bf73221 | 2022-09-12 18:11:22 +0000 | [diff] [blame] | 267 | |
Rob Mohr | fabf49c | 2023-04-11 20:08:52 +0000 | [diff] [blame] | 268 | clang_prefix = toolchain_dir / 'bin' |
Rob Mohr | bf73221 | 2022-09-12 18:11:22 +0000 | [diff] [blame] | 269 | env.override_gn_args[ |
| 270 | 'pw_toolchain_CLANG_PREFIX' |
Rob Mohr | a65a197 | 2022-09-13 16:25:39 +0000 | [diff] [blame] | 271 | ] = f'{clang_prefix}/' |
Rob Mohr | dc93dd9 | 2022-08-13 00:15:04 +0000 | [diff] [blame] | 272 | |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 273 | def init( |
Rob Mohr | 500364a | 2023-02-01 15:05:30 +0000 | [diff] [blame] | 274 | self, checkout, options=None, use_constraint_file=True, |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 275 | ): |
Rob Mohr | 500364a | 2023-02-01 15:05:30 +0000 | [diff] [blame] | 276 | pigweed_root = checkout.root |
Rob Mohr | bf73221 | 2022-09-12 18:11:22 +0000 | [diff] [blame] | 277 | env = Environment( |
Rob Mohr | fabf49c | 2023-04-11 20:08:52 +0000 | [diff] [blame] | 278 | api=self.m, dir=checkout.root / 'environment', checkout=checkout, |
Rob Mohr | bf73221 | 2022-09-12 18:11:22 +0000 | [diff] [blame] | 279 | ) |
Rob Mohr | e47c658 | 2022-07-14 16:33:10 +0000 | [diff] [blame] | 280 | |
Rob Mohr | e447515 | 2022-11-16 20:04:36 +0000 | [diff] [blame] | 281 | # If in recipe tests always add at least one variable to make it easier |
| 282 | # to test use of variables in recipes. |
| 283 | if self._test_data.enabled: |
| 284 | env.env['PW_TEST_VAR'] = 'test_value' |
| 285 | |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 286 | if not options.config_file: |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 287 | return env |
Rob Mohr | 3b7da06 | 2020-04-30 14:30:57 -0700 | [diff] [blame] | 288 | |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 289 | if options.relative_pigweed_root not in (None, '', '.'): |
Rob Mohr | fabf49c | 2023-04-11 20:08:52 +0000 | [diff] [blame] | 290 | pigweed_root = checkout.root / options.relative_pigweed_root |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 291 | |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 292 | with self.m.step.nest('environment') as pres: |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 293 | env.env['PW_ROOT'] = pigweed_root |
Rob Mohr | 500364a | 2023-02-01 15:05:30 +0000 | [diff] [blame] | 294 | env.env['PW_PROJECT_ROOT'] = checkout.root |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 295 | |
| 296 | self._init_platform(env) |
Rob Mohr | 9a39718 | 2022-07-12 02:00:24 +0000 | [diff] [blame] | 297 | self._init_misc_vars(env, options.additional_variables) |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 298 | self._init_pigweed( |
Rob Mohr | 500364a | 2023-02-01 15:05:30 +0000 | [diff] [blame] | 299 | checkout=checkout, |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 300 | top_presentation=pres, |
| 301 | use_constraint_file=use_constraint_file, |
| 302 | pigweed_root=pigweed_root, |
Rob Mohr | 9794dc8 | 2023-07-22 00:19:43 +0000 | [diff] [blame] | 303 | options=options, |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 304 | env=env, |
| 305 | ) |
Rob Mohr | dc93dd9 | 2022-08-13 00:15:04 +0000 | [diff] [blame] | 306 | self._toolchain_override(env) |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 307 | |
Rob Mohr | 322b7aa | 2022-09-07 19:45:05 +0000 | [diff] [blame] | 308 | with env(): |
| 309 | # If 'pw doctor' fails we can continue, but show the doctor |
| 310 | # failure in red in the UI. |
| 311 | try: |
| 312 | self.m.step('doctor', ['python', '-m', 'pw_cli', 'doctor']) |
| 313 | except self.m.step.StepFailure: |
| 314 | pass |
| 315 | |
Rob Mohr | faa377f | 2022-01-19 14:38:36 -0800 | [diff] [blame] | 316 | return env |