Script scaffold throwing error

Laith_Budairi · November 27, 2024, 7:01am

I have forked and cloned the core repo to see how to add an integration, I’ve done the needed steps but when I get to generate an integration using script.scaffold, when it starts running the hassfest part, I get the following error:

I tried removing these 2 lines in the quality_scale.py and it worked after rerunning the command again, but I am not sure that it’s correct this way to remove these lines:

what I am trying to know is why it failed there and how can I avoid that without removing these lines?

I am using WSL on Windows by the way.

cloudUser98 · November 27, 2024, 7:15pm

I had the same erorr today trying to create my development environment.

Running the script hassfest manually throws the following error:

Integration integration_name:
* [ERROR] [QUALITY_SCALE] Quality scale definition not found. New integrations are required to at least reach the Bronze tier.

i haven’t found a solution yet.

vincen · January 17, 2025, 6:08pm

Hi

Did you find a solution ? as I hit the same issue and can’t find a solution even here in forum

Thanks

Vincèn

JohansLab · January 20, 2025, 7:20pm

I must be honest I don’t understand the change in development flow. You need a quality_scale.yaml file in your integration marking items as done. But I am not sure how it is not a circular dependency – I need to run hassfest script so I can test SSPD integration so I can complete the quality scale requirements but I need to complete the quality scale requirements before I can run the hassfest script. So in the meantime so I can continue working the content of my quality_scale.yaml file is :

rules:
  # Bronze
  action-setup: 
    status: exempt
    comment: |
      This integration is in development and requires a manifest for debugging purposes.
  appropriate-polling: 
    status: exempt
    comment: |
      This integration is in development and requires a manifest for debugging purposes.
  brands: 
    status: exempt
    comment: |
      This integration is in development and requires a manifest for debugging purposes.
  common-modules: 
    status: exempt
    comment: |
      This integration is in development and requires a manifest for debugging purposes.
  config-flow-test-coverage: 
    status: exempt
    comment: |
      This integration is in development and requires a manifest for debugging purposes.
  config-flow: 
    status: exempt
    comment: |
      This integration is in development and requires a manifest for debugging purposes.
  dependency-transparency: 
    status: exempt
    comment: |
      This integration is in development and requires a manifest for debugging purposes.
  docs-actions: 
    status: exempt
    comment: |
      This integration is in development and requires a manifest for debugging purposes.
  docs-high-level-description: 
    status: exempt
    comment: |
      This integration is in development and requires a manifest for debugging purposes.
  docs-installation-instructions: 
    status: exempt
    comment: |
      This integration is in development and requires a manifest for debugging purposes.
  docs-removal-instructions: 
    status: exempt
    comment: |
      This integration is in development and requires a manifest for debugging purposes.
  entity-event-setup: 
    status: exempt
    comment: |
      This integration is in development and requires a manifest for debugging purposes.
  entity-unique-id: 
    status: exempt
    comment: |
      This integration is in development and requires a manifest for debugging purposes.
  has-entity-name: 
    status: exempt
    comment: |
      This integration is in development and requires a manifest for debugging purposes.
  runtime-data: 
    status: exempt
    comment: |
      This integration is in development and requires a manifest for debugging purposes.
  test-before-configure: 
    status: exempt
    comment: |
      This integration is in development and requires a manifest for debugging purposes.
  test-before-setup: 
    status: exempt
    comment: |
      This integration is in development and requires a manifest for debugging purposes.
  unique-config-entry: 
    status: exempt
    comment: |
      This integration is in development and requires a manifest for debugging purposes.

Laith_Budairi · January 21, 2025, 7:06am

what I did was pulling the latest changes in the dev branch and trying again then it just worked

vincen · January 21, 2025, 8:55am

a dirty workaround posted here for the script failing:

github.com/home-assistant/core

script.scaffold broke for fresh installations due to hassfest failure

opened 08:25AM - 18 Oct 24 UTC

thargy

### The problem When running `python3 -m script.scaffold integration` on a fres…h devcontainer, as per [the instructions for creating an integration](https://developers.home-assistant.io/docs/creating_component_index/), the following error occurs: ```log ... Running hassfest to pick up new information. Traceback (most recent call last): File "<frozen runpy>", line 198, in _run_module_as_main File "<frozen runpy>", line 88, in _run_code File "/workspaces/home-assistant-core/script/scaffold/__main__.py", line 117, in <module> sys.exit(main()) ^^^^^^ File "/workspaces/home-assistant-core/script/scaffold/__main__.py", line 70, in main subprocess.run(["python", "-m", "script.hassfest"], **pipe_null, check=True) File "/usr/local/lib/python3.12/subprocess.py", line 571, in run raise CalledProcessError(retcode, process.args, subprocess.CalledProcessError: Command '['python', '-m', 'script.hassfest']' returned non-zero exit status 1. ``` Running `python -m script.hassfest` directly gives the following error: ```log ... Found errors. Generating files canceled. Integration example_domain: * [ERROR] [TRANSLATIONS] strings.json::options::step::init::data::entity_id contains invalid reference component::NEW_DOMAIN::config::step::user::description: Could not find NEW_DOMAIN ``` A search of the newly generated custom_component shows that `strings.json` contains the following: ```json { "config": { "step": { "user": { "description": "New NEW_NAME Sensor", "data": { "entity_id": "Input sensor", "name": "Name" } } } }, "options": { "step": { "init": { "data": { "entity_id": "[%key:component::NEW_DOMAIN::config::step::user::description%]" } } } } } ``` Replacing `NEW_DOMAIN` with the correct domain (`example_domain` here) allows `hassfest` to pass using `python -m script.hassfest`. You can then build translations using: ```bash python -m script.translations develop --integration example_domain ``` However, 2 of the scaffolded tests also fail: ```bash $ python3 -b -m pytest -vvv tests/components/example_domain ... # Check the entity was updated, no new entity was created > assert len(hass.states.async_all()) == 1 E assert 0 == 1 E + where 0 = len([]) E + where [] = async_all() E + where async_all = <homeassistant.core.StateMachine object at 0x7f85dd87bb50>.async_all E + where <homeassistant.core.StateMachine object at 0x7f85dd87bb50> = <HomeAssistant RUNNING>.states tests/components/example_domain/test_config_flow.py:113: AssertionError ... # TODO Check the state of the entity has changed as expected assert state.state == "unknown" > assert state.attributes == {} E AssertionError: assert {'friendly_name': 'My example_domain'} == {} E E Left contains 1 more item: E {'friendly_name': 'My example_domain'} E E Full diff: E - {} E + { E + 'friendly_name': 'My example_domain', E + } tests/components/example_domain/test_init.py:43: AssertionError ``` The first failure requires more investigation as `hass.states` contains 0 states. The latter seems to be due to not expecting the automatically added 'friendly_name' attribute and can be easily fixed. ### What version of Home Assistant Core has the issue? core-2024.11.0.dev0 ### What was the last working version of Home Assistant Core? _No response_ ### What type of installation are you running? Home Assistant Core ### Integration causing the issue _No response_ ### Link to integration documentation on our website _No response_ ### Diagnostics information _No response_ ### Example YAML snippet _No response_ ### Anything in the logs that might be useful for us? _No response_ ### Additional information _No response_

JohansLab · January 21, 2025, 3:04pm

Well you need to a quaility_scale.yaml file in any case so might as well start with one Otherwise will probably just hit a brick wall later on in the process.