Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ansible/ovos] Make sure .local belongs to user #259

Merged
merged 1 commit into from
Feb 12, 2025

Conversation

goldyfruit
Copy link
Member

@goldyfruit goldyfruit commented Feb 12, 2025

Summary by CodeRabbit

  • Chores

    • Streamlined the backup process and directory handling to enhance the uninstallation routine.
  • Refactor

    • Adjusted the conditions for checking and creating directories to ensure a consistent configuration setup during installation and uninstallation.

@goldyfruit goldyfruit added the bug Something isn't working label Feb 12, 2025
@goldyfruit goldyfruit added this to the Commander Keen milestone Feb 12, 2025
@goldyfruit goldyfruit self-assigned this Feb 12, 2025
Copy link
Contributor

coderabbitai bot commented Feb 12, 2025

Walkthrough

This pull request updates the OVOS installer Ansible playbook to refine directory management and backup operations. The modifications remove the .local/state/mycroft directory from the backup list, update directory creation to use .local instead, and adjust conditions for creating hivemind directories based on the installer profile. The backup process remains conditional on directory existence and cleaning flags, while the template generation for mycroft.conf continues unchanged. There are no changes to exported or public entities.

Changes

File Change Summary
ansible/roles/ovos_installer/tasks/ovos.yml - Removed .local/state/mycroft from backup list.
- Updated directory creation logic: now uses .local and adjusts conditions for hivemind directories.
- Retained conditional backup operations and template generation logic.

Sequence Diagram(s)

sequenceDiagram
    participant I as OVOS Installer
    participant DC as Directory Checker
    participant BP as Backup Processor
    participant DR as Directory Creator
    participant TG as Template Generator

    I->>DC: Check existence of backup directories
    DC-->>I: Return existence status
    I->>BP: Proceed with backup if directories exist and cleaning flag set
    BP-->>I: Backup complete
    I->>DR: Create directories (.local and hivemind based on profile)
    DR-->>I: Confirm directory creation
    I->>TG: Generate mycroft.conf using installation method
    TG-->>I: Configuration file generated
Loading

Possibly related PRs

Poem

Hoppity-hop, in code I play,
Directories change in a neat display.
I trim the paths with a careful touch,
Backups and folders now balanced as such.
A rabbit's leap through logic so spry—coding wonders float by!


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using 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 do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@goldyfruit goldyfruit merged commit bc08aef into main Feb 12, 2025
6 of 9 checks passed
@goldyfruit goldyfruit deleted the fix/local_permissions branch February 12, 2025 13:43
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🔭 Outside diff range comments (1)
ansible/roles/ovos_installer/tasks/ovos.yml (1)

66-68: ⚠️ Potential issue

Fix logical condition in hivemind directory creation.

The condition ovos_installer_profile == 'ovos' and ovos_installer_profile == 'server' will never be true as a variable cannot equal two different values simultaneously.

    - {
        "directory": "{{ ovos_installer_user_home }}/hivemind",
-       "status": "{{ 'false' if (ovos_installer_profile == 'ovos' and ovos_installer_profile == 'server') else 'true' }}",
+       "status": "{{ 'false' if (ovos_installer_profile == 'ovos' or ovos_installer_profile == 'server') else 'true' }}",
    }

Apply the same fix to the other hivemind directory conditions at lines 71 and 75.

🧹 Nitpick comments (1)
ansible/roles/ovos_installer/tasks/ovos.yml (1)

4-14: Consider security and completeness of backup operations.

Two suggestions for the backup configuration:

  1. The wildcard patterns (*) in backup paths might miss hidden files. Consider using .* in addition to *.
  2. The backup archive permissions (0755) are too permissive for potentially sensitive user configuration data.
  ovos_directories_backup:
-     - "{{ ovos_installer_user_home }}/ovos/*"
+     - "{{ ovos_installer_user_home }}/ovos/{*,.*}"
      # Apply similar pattern to other paths...

  community.general.archive:
    path: "{{ ovos_directories_backup }}"
    dest: "{{ ovos_installer_user_home }}/ovos-backup.tar.gz"
    owner: "{{ ovos_installer_user }}"
    group: "{{ ovos_installer_group }}"
-   mode: "0755"
+   mode: "0600"

Also applies to: 29-33

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 636d603 and ef898e5.

📒 Files selected for processing (1)
  • ansible/roles/ovos_installer/tasks/ovos.yml (1 hunks)
🔇 Additional comments (2)
ansible/roles/ovos_installer/tasks/ovos.yml (2)

93-96: Validate existing .local directory permissions.

The .local directory is a standard user directory that might already exist. Changing its ownership could affect other applications.

Consider adding a check for existing permissions before modification:

- name: Check .local directory permissions
  ansible.builtin.stat:
    path: "{{ ovos_installer_user_home }}/.local"
  register: local_dir_stat

- name: Ensure .local directory exists with correct permissions
  ansible.builtin.file:
    path: "{{ ovos_installer_user_home }}/.local"
    owner: "{{ ovos_installer_user }}"
    group: "{{ ovos_installer_group }}"
    mode: "0755"
    state: directory
  when: 
    - not local_dir_stat.stat.exists or 
      local_dir_stat.stat.pw_name != ovos_installer_user

111-122: Configuration generation looks good!

The configuration path selection and file permissions are appropriate. The backup flag provides safety for existing configurations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant