• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1#!/usr/bin/env python3
2# -*- coding: utf-8 -*-
3
4#
5# Copyright (c) 2023 Huawei Device Co., Ltd.
6# Licensed under the Apache License, Version 2.0 (the "License");
7# you may not use this file except in compliance with the License.
8# You may obtain a copy of the License at
9#
10#     http://www.apache.org/licenses/LICENSE-2.0
11#
12# Unless required by applicable law or agreed to in writing, software
13# distributed under the License is distributed on an "AS IS" BASIS,
14# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15# See the License for the specific language governing permissions and
16# limitations under the License.
17#
18
19import os
20import sys
21
22from exceptions.ohos_exception import OHOSException
23from services.interface.build_executor_interface import BuildExecutorInterface
24from resources.config import Config
25from util.system_util import SystemUtil, ExecEnviron
26from util.io_util import IoUtil
27from util.log_util import LogUtil
28
29
30class Ninja(BuildExecutorInterface):
31
32    def __init__(self):
33        super().__init__()
34        self.config = Config()
35        self._regist_ninja_path()
36
37    def run(self):
38        self._execute_ninja_cmd()
39
40    def _execute_ninja_cmd(self):
41        """execute ninja cmd using registed args
42        :raise OHOSException: when ninja failed
43        """
44        ninja_cmd = [self.exec, '-w', 'dupbuild=warn',
45                     '-C', self.config.out_path] + self._convert_args()
46        LogUtil.write_log(self.config.log_path,
47                          'Excuting ninja command: {}'.format(' '.join(ninja_cmd)), 'info')
48
49        ninja_env = ExecEnviron()
50        ninja_env_allowlist = IoUtil.read_json_file(
51            os.path.join(
52                self.config.root_path,
53                "out/preloader",
54                self.config.product,
55                "compile_env_allowlist.json",
56            )
57        ).get("ninja")
58
59        if ninja_env_allowlist:
60            ninja_env.initenv()
61            ninja_env.allow(ninja_env_allowlist)
62            LogUtil.write_log(
63                self.config.log_path,
64                f"run ninja with environ {ninja_env.allkeys}",
65                "info",
66            )
67
68        log_filter = os.getenv("LOG_FILTER", "True") == "True"
69        SystemUtil.exec_command(
70            ninja_cmd,
71            self.config.log_path,
72            exec_env=ninja_env.allenv,
73            log_filter=log_filter,
74            log_mode=self.config.log_mode
75        )
76
77    def _convert_args(self) -> list:
78        """convert all registed args into a list
79        """
80        args_list = []
81        for key, value in self._args_dict.items():
82            if key == 'build_target' and isinstance(value, list):
83                args_list += value
84            elif key == 'ninja_args' and isinstance(value, list):
85                args_list += value
86            else:
87                if value == '':
88                    args_list.insert(0, key)
89                else:
90                    args_list.insert(0, ' {}{} '.format(key, value))
91        return args_list
92
93    def _regist_ninja_path(self):
94        """find ninja executable
95        :raise OHOSException: when can't find the ninja excutable
96        """
97        ninja_path = os.path.join(self.config.root_path, 'prebuilts/build-tools/{}-x86/bin/ninja'
98                .format(sys.platform))
99        if os.path.exists(ninja_path):
100            self.exec = ninja_path
101        else:
102            raise OHOSException(
103                'There is no gn executable file at {}'.format(ninja_path), '0001')
104