39fd61d7dd
Previously, the `subprocess` module was used to execute shell command installing precommit hook. However, after #431 [1], the import of the `subprocess` module was overriden by `asyncio.subprocess`, which has a different API to execute the shell command. This change removes the `asyncio.subprocess` import. [1] https://github.com/gem5/gem5/pull/431 Change-Id: I9a7d51f85518089d258ab57c5d849a36dcf128e9 Signed-off-by: Hoa Nguyen <hn@hnpl.org>
116 lines
4.3 KiB
Python
116 lines
4.3 KiB
Python
# Copyright (c) 2013, 2015-2017 ARM Limited
|
|
# All rights reserved.
|
|
#
|
|
# The license below extends only to copyright in the software and shall
|
|
# not be construed as granting a license to any other intellectual
|
|
# property including but not limited to intellectual property relating
|
|
# to a hardware implementation of the functionality of the software
|
|
# licensed hereunder. You may use the software subject to the license
|
|
# terms below provided that you ensure that this notice is replicated
|
|
# unmodified and in its entirety in all distributions of the software,
|
|
# modified or unmodified, in source code or in binary form.
|
|
#
|
|
# Copyright (c) 2011 Advanced Micro Devices, Inc.
|
|
# Copyright (c) 2009 The Hewlett-Packard Development Company
|
|
# Copyright (c) 2004-2005 The Regents of The University of Michigan
|
|
# All rights reserved.
|
|
#
|
|
# Redistribution and use in source and binary forms, with or without
|
|
# modification, are permitted provided that the following conditions are
|
|
# met: redistributions of source code must retain the above copyright
|
|
# notice, this list of conditions and the following disclaimer;
|
|
# redistributions in binary form must reproduce the above copyright
|
|
# notice, this list of conditions and the following disclaimer in the
|
|
# documentation and/or other materials provided with the distribution;
|
|
# neither the name of the copyright holders nor the names of its
|
|
# contributors may be used to endorse or promote products derived from
|
|
# this software without specific prior written permission.
|
|
#
|
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
import os
|
|
import subprocess
|
|
import sys
|
|
|
|
import gem5_scons.util
|
|
import SCons.Script
|
|
|
|
git_style_message = """
|
|
You're missing the pre-commit/commit-msg hooks. These hook help to ensure your
|
|
code follows gem5's style rules on git commit and your commit messages follow
|
|
our commit message requirements. This script will now install these hooks in
|
|
your .git/hooks/ directory.
|
|
Press enter to continue, or ctrl-c to abort:
|
|
"""
|
|
|
|
|
|
def install_style_hooks(env):
|
|
try:
|
|
gitdir = env.Dir(
|
|
gem5_scons.util.readCommand(
|
|
["git", "rev-parse", "--git-dir"]
|
|
).strip("\n")
|
|
)
|
|
except Exception as e:
|
|
print(f"Warning: Failed to find git repo directory: {e}")
|
|
return
|
|
|
|
git_hooks = gitdir.Dir("hooks")
|
|
|
|
def hook_exists(hook_name):
|
|
hook = git_hooks.File(hook_name)
|
|
return hook.exists()
|
|
|
|
if hook_exists("pre-commit") and hook_exists("commit-msg"):
|
|
return
|
|
|
|
print(git_style_message, end=" ")
|
|
if SCons.Script.GetOption("install_hooks"):
|
|
print("Installing revision control hooks automatically.")
|
|
else:
|
|
try:
|
|
input()
|
|
except:
|
|
print("Input exception, exiting scons.\n")
|
|
sys.exit(1)
|
|
|
|
pre_commit_install = env.Dir("#util").File("pre-commit-install.sh")
|
|
|
|
ret = subprocess.call(str(pre_commit_install), shell=True)
|
|
if ret != 0:
|
|
print(
|
|
"It is strongly recommended you install the pre-commit hooks "
|
|
"before working with gem5. Do you want to continue compilation "
|
|
"(y/n)?"
|
|
)
|
|
while True:
|
|
response = input().lower().strip()
|
|
if response in {"yes", "ye", "y"}:
|
|
return
|
|
elif response in {"no", "n"}:
|
|
sys.exit(1)
|
|
else:
|
|
print(
|
|
f"Could not parse answer '{response}'. Do you want to "
|
|
"continue compilation (y/n)?"
|
|
)
|
|
|
|
|
|
def generate(env):
|
|
if exists(env) and not gem5_scons.util.ignore_style():
|
|
install_style_hooks(env)
|
|
|
|
|
|
def exists(env):
|
|
return env.Entry("#.git").exists()
|