mirror of
https://github.com/home-assistant/core.git
synced 2025-04-26 18:27:51 +00:00
1a4738b1d4
* fix(scaffold): integration generation Fix script.scaffold integration generation which was failing due to hassfest quality check. Add the required `quality_scale` to the generated integration manifest.json. Use the new `--skip-plugins` flag to skip the hassfest quality check when generating integrations, as the quality scale rules are marked as todo, and only run against the generated integration. Correct typo in help for hassfest command `--plugins` flag. Update Integration.core method to use absolute path to ensure it returns the true if the integration is a core integration, which was causing other checks to fail, as the integration was not being marked as core. Always output subprocess output as it contains the error message when a command fails, without this the user would not know why the command failed. Fixes: #128639 * Adjust comment language --------- Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
133 lines
3.6 KiB
Python
133 lines
3.6 KiB
Python
"""Validate manifests."""
|
|
|
|
import argparse
|
|
from pathlib import Path
|
|
import subprocess
|
|
import sys
|
|
|
|
from script.util import valid_integration
|
|
|
|
from . import docs, error, gather_info, generate
|
|
|
|
TEMPLATES = [
|
|
p.name for p in (Path(__file__).parent / "templates").glob("*") if p.is_dir()
|
|
]
|
|
|
|
|
|
def get_arguments() -> argparse.Namespace:
|
|
"""Get parsed passed in arguments."""
|
|
parser = argparse.ArgumentParser(description="Home Assistant Scaffolder")
|
|
parser.add_argument("template", type=str, choices=TEMPLATES)
|
|
parser.add_argument(
|
|
"--develop", action="store_true", help="Automatically fill in info"
|
|
)
|
|
parser.add_argument(
|
|
"--integration", type=valid_integration, help="Integration to target."
|
|
)
|
|
|
|
return parser.parse_args()
|
|
|
|
|
|
def main() -> int:
|
|
"""Scaffold an integration."""
|
|
if not Path("requirements_all.txt").is_file():
|
|
print("Run from project root")
|
|
return 1
|
|
|
|
args = get_arguments()
|
|
|
|
info = gather_info.gather_info(args)
|
|
print()
|
|
|
|
# If we are calling scaffold on a non-existing integration,
|
|
# We're going to first make it. If we're making an integration,
|
|
# we will also make a config flow to go with it.
|
|
|
|
if info.is_new:
|
|
generate.generate("integration", info)
|
|
|
|
# If it's a new integration and it's not a config flow,
|
|
# create a config flow too.
|
|
if not args.template.startswith("config_flow"):
|
|
if info.helper:
|
|
template = "config_flow_helper"
|
|
elif info.oauth2:
|
|
template = "config_flow_oauth2"
|
|
elif info.authentication or not info.discoverable:
|
|
template = "config_flow"
|
|
else:
|
|
template = "config_flow_discovery"
|
|
|
|
generate.generate(template, info)
|
|
|
|
hassfest_args = [
|
|
"python",
|
|
"-m",
|
|
"script.hassfest",
|
|
]
|
|
|
|
# If we wanted a new integration, we've already done our work.
|
|
if args.template != "integration":
|
|
generate.generate(args.template, info)
|
|
else:
|
|
hassfest_args.extend(
|
|
[
|
|
"--integration-path",
|
|
info.integration_dir,
|
|
"--skip-plugins",
|
|
"quality_scale", # Skip quality scale as it will fail for newly generated integrations.
|
|
]
|
|
)
|
|
|
|
# Always output sub commands as the output will contain useful information if a command fails.
|
|
print("Running hassfest to pick up new information.")
|
|
subprocess.run(hassfest_args, check=True)
|
|
print()
|
|
|
|
print("Running gen_requirements_all to pick up new information.")
|
|
subprocess.run(["python", "-m", "script.gen_requirements_all"], check=True)
|
|
print()
|
|
|
|
print("Running script/translations_develop to pick up new translation strings.")
|
|
subprocess.run(
|
|
[
|
|
"python",
|
|
"-m",
|
|
"script.translations",
|
|
"develop",
|
|
"--integration",
|
|
info.domain,
|
|
],
|
|
check=True,
|
|
)
|
|
print()
|
|
|
|
if args.develop:
|
|
print("Running tests")
|
|
print(f"$ python3 -b -m pytest -vvv tests/components/{info.domain}")
|
|
subprocess.run(
|
|
[
|
|
"python3",
|
|
"-b",
|
|
"-m",
|
|
"pytest",
|
|
"-vvv",
|
|
f"tests/components/{info.domain}",
|
|
],
|
|
check=True,
|
|
)
|
|
print()
|
|
|
|
docs.print_relevant_docs(args.template, info)
|
|
|
|
return 0
|
|
|
|
|
|
if __name__ == "__main__":
|
|
try:
|
|
sys.exit(main())
|
|
except error.ExitApp as err:
|
|
print()
|
|
print(f"Fatal Error: {err.reason}")
|
|
sys.exit(err.exit_code)
|