Improve tests of HacsRepository.get_documentation

[emontnemery]

Improve tests of HacsRepository.get_documentation to also test replacing svg tags

[emontnemery]

@coderabbitai review

[coderabbitai[bot]]

Walkthrough

## Walkthrough The recent changes introduce a new example readme file and a JSON configuration file for an integration named "Integration basic SVG 1.0.0". Additionally, the test cases in `test_get_documentation.py` have been updated to reflect new integration names and expected outcomes, including modifications to function parameters and assertions. ## Changes | File Path | Change Summary | |---------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------| | `tests/fixtures/proxy/raw.githubusercontent.com/hacs-test-org/integration-basic-svg/1.0.0/README.md` | Introduced an example readme file with `

---

Recent Review Details

**Configuration used: CodeRabbit UI** **Review profile: ASSERTIVE**

Commits

Files that changed from the base of the PR and between 722ed462b4b144e16affdc7c7ba3083dd1e399d4 and 1bf8e4955ca470c6266516e4f440d3345499cceb.

Files selected for processing (3)

* tests/fixtures/proxy/raw.githubusercontent.com/hacs-test-org/integration-basic-svg/1.0.0/README.md (1 hunks) * tests/fixtures/proxy/raw.githubusercontent.com/hacs-test-org/integration-basic-svg/1.0.0/hacs.json (1 hunks) * tests/repositories/test_get_documentation.py (1 hunks)

Additional Context Used

Markdownlint (1)

tests/fixtures/proxy/raw.githubusercontent.com/hacs-test-org/integration-basic-svg/1.0.0/README.md (1)

1: null Files should end with a single newline character

Additional comments not posted (2)

tests/fixtures/proxy/raw.githubusercontent.com/hacs-test-org/integration-basic-svg/1.0.0/hacs.json (1)

`1-3`: The JSON structure is correctly formatted and aligns with the expected standards.

tests/repositories/test_get_documentation.py (1)

`12-39`: The updates to the test function are well-implemented. The parameterization covers various scenarios effectively, and the assertions are appropriate for the tests.

--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to full the review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[emontnemery]

Closing in favor of https://github.com/hacs/integration/pull/3724