Schedule user logged in by creativeprojects · Pull Request #470 · creativeprojects/resticprofile

creativeprojects · 2025-03-17T21:28:09Z

Implementation of user and user_logged_in for systemd and launchd

This fixes a long standing issue where user permission was in reality user_logged_in when using systemd and launchd

Fixes #331

move detectSchedulePermission to the handler which broke many tests using the mock handler

coderabbitai · 2025-03-17T21:28:15Z

Walkthrough

This pull request spans multiple files across the project. It updates GitHub Actions workflows for broken link checking, modifies configuration files (e.g. Makefile, .gitignore, codecov.yml), and improves scheduling functionality. In the schedule subsystem, permission handling is refactored by switching from string‐based permissions to a new integer-based type, with corresponding updates to handlers, mocks, tests, and documentation. In addition, new fields enabling per-user scheduling (e.g. a new User field in the systemd service generator) have been introduced alongside enhancements to the darwin and user packages.

Changes

File(s)	Change Summary
`.github/workflows/doc.yml`, `.github/workflows/release-doc.yml`	Updated `cmd_params` in the "Check broken links" step: added exclusion for `0-18` and escaped dots in domain names.
`.gitignore`, `codecov.yml`	Added new ignore patterns for log files and the `crontab` file; updated code coverage to ignore specific files (e.g. `user/user_systemd.go`).
`Makefile`	Added uid/gid options for tmpfs mount; modified muffet command exclusion pattern to include `0-18` with corrected regex.
`commands_schedule_test.go`	Introduced new schedule permission fields (`schedule-permission` and `permission`) in backup profile configurations.
`constants/value.go`	Added new constants (`SchedulePermissionAuto`, `SchedulePermissionSystem`) and repositioned schedule priority constants.
`crond/*`	Added build constraints for non-Windows platforms; simplified username retrieval by removing redundant error handling.
`darwin/*`	Renamed package from `schedule` to `darwin`; exported previously unexported functions; introduced new launchd job struct, process and session types along with corresponding tests.
`docs/content/schedules/`, `examples/`, `sample.service`	Restructured and clarified scheduling documentation; updated configuration examples to remove global scheduler settings and reflect profile-specific scheduling.
`schedule/*`	Updated handler methods to accept a new `Permission` type (converted from strings to integer constants); introduced `DetectSchedulePermission` and `CheckPermission` methods; refactored tests and mocks to align with permission changes.
`systemd/*`	Added a new `User` field in both service generation (in `generate.go`) and configuration reading (in `read.go`); updated command handling and tests to support per-user scheduling.
`user/*`	Introduced a new user package defining a `User` struct and associated methods to obtain current user details, check for lingering sessions, and provide platform-specific implementations (including Windows).

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant HS as HandlerSystemd
    participant SG as SystemdGenerator
    participant OS as OS Environment

    U->>HS: Request job creation with specific permission
    HS->>HS: Call DetectSchedulePermission(permission)
    HS->>SG: Invoke Generate(config with User field)
    SG->>OS: Retrieve user info (via user.Current or os.UserHomeDir)
    OS-->>SG: Return home directory and environment details
    SG-->>HS: Return generated service file
    HS->>U: Confirm scheduled job creation

Assessment against linked issues

Objective	Addressed	Explanation
Run system scheduler as a different user with per-profile configuration (#331)	✅

✨ Finishing Touches

📝 Generate Docstrings

🪧 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.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@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.

codecov · 2025-03-18T17:14:32Z

Codecov Report

Attention: Patch coverage is 73.24263% with 118 lines in your changes missing coverage. Please review.

Project coverage is 79.46%. Comparing base (edbea57) to head (659e422).
Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
schedule/handler_darwin.go	66.91%	40 Missing and 5 partials ⚠️
schedule/handler_systemd.go	64.46%	36 Missing and 7 partials ⚠️
schedule/job.go	44.44%	7 Missing and 3 partials ⚠️
user/user_other.go	69.23%	7 Missing and 1 partial ⚠️
schedule/handler_crond.go	88.89%	3 Missing and 1 partial ⚠️
schedule/handler_windows.go	75.00%	3 Missing ⚠️
systemd/generate.go	81.25%	2 Missing and 1 partial ⚠️
darwin/calendar_interval.go	50.00%	1 Missing ⚠️
schtasks/taskscheduler.go	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #470      +/-   ##
==========================================
+ Coverage   79.36%   79.46%   +0.10%     
==========================================
  Files         131      132       +1     
  Lines       12959    13169     +210     
==========================================
+ Hits        10284    10464     +180     
- Misses       2269     2292      +23     
- Partials      406      413       +7

Flag	Coverage Δ
unittests	`79.46% <73.24%> (+0.10%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (14)

crond/entry.go (1)

36-40: WithUser Method Implementation:
The WithUser method appropriately trims the input value before assigning it to the user field. This helps prevent issues with extraneous whitespace. Consider if additional validation is required for special cases (e.g. values like "*" or "-").

user/user.go (1)

1-9: New User Package and User Struct:
A new package user has been introduced, featuring the User struct with fields for UID, GID, Username, HomeDir, and SudoRoot. The implementation is straightforward; however, adding documentation comments for each field would enhance clarity and maintainability. Additionally, consider implementing unit tests to verify the behaviour of any future methods that utilise this struct.

codecov.yml (1)

15-15: Clarification on Ignored Coverage File.
The new entry - user/user_systemd.go is now excluded from code coverage. Please confirm that this file’s omission is intentional—if it contains user permission handling that might be critical (especially with the recent changes regarding user permissions), ensure that its functionality is sufficiently tested elsewhere or reconsider ignoring it.

.gitignore (1)

6-10: New Ignore Patterns for Log and Crontab Files.
The inclusion of /examples/*-log.txt and /crontab prevents tracking of generated log files and the crontab file. Please verify that these patterns accurately capture the intended files and that no essential files are being unintentionally ignored.

examples/dev.yaml (1)

136-144: Commented out forget and copy sections

I notice these sections have been commented out rather than removed. Consider whether these should be completely removed or if they're intended to be re-enabled later.
examples/linux.yaml (1)
105-105: Fix indentation in schedule section

The indentation for the at property is incorrect according to YAML standards. It should be indented with 12 spaces to match the parent structure.
-        at: "*:15,20,25"
+          at: "*:15,20,25"
🧰 Tools

🪛 YAMLlint (1.35.1)

[warning] 105-105: wrong indentation: expected 12 but found 10

(indentation)
schedule/schedules_test.go (1)
73-73: Consider using a more flexible approach for systemd-analyze path.

Using the absolute path /usr/bin/systemd-analyze makes the test more brittle as it will fail if the binary is installed in a different location. On some systems, it might be in /bin/systemd-analyze or elsewhere.

Consider one of these alternatives:
-_, err := exec.LookPath("/usr/bin/systemd-analyze")
+_, err := exec.LookPath("systemd-analyze")
Or if you need to check specific paths:
-_, err := exec.LookPath("/usr/bin/systemd-analyze")
+_, err := findSystemdAnalyze()
With a helper function like:
func findSystemdAnalyze() (string, error) {
    // Try common locations
    for _, path := range []string{"/usr/bin/systemd-analyze", "/bin/systemd-analyze"} {
        if _, err := os.Stat(path); err == nil {
            return path, nil
        }
    }
    // Fall back to PATH lookup
    return exec.LookPath("systemd-analyze")
}
docs/content/schedules/systemd.md (1)
32-37: Improved readability with bullet points, but contains duplicated word

The restructured section using bullet points improves readability by clearly separating the steps. However, there's a duplicated "Run" in line 36-37.

Correct the duplicated word by applying this change:
- Run `systemctl enable` - Run `systemctl start`
+ Run `systemctl enable`
+ Run `systemctl start`
🧰 Tools

🪛 LanguageTool

[duplication] ~36-~36: Possible typo: you repeated a word.
Context: ...edule-permissionis set tosystem) - Run systemctl enable- Runsystemctl start` ## Priority and CPU ...

(ENGLISH_WORD_REPEAT_RULE)
docs/content/schedules/launchd.md (1)
10-10: Consider standardising the naming convention.
Your text mentions user_logged-on. In the codebase, we often see PermissionUserLoggedOn. For consistency, you might prefer an underscore instead of a dash:
- A user agent is generated when you set `schedule-permission` to `user` or `user_logged-on`.
+ A user agent is generated when you set `schedule-permission` to `user` or `user_logged_on`.
schedule/handler_windows.go (1)

74-74: The permission parameter is not consumed here.
Consider removing it from the signature or using it if necessary for future logic.

docs/content/schedules/_index.md (1)

18-18: Potential grammar improvement.
“otherwise” is used as an adverb; consider rewording to avoid confusion, for example:

On Unix systems (excluding macOS), resticprofile uses systemd if available. If it isn’t available, it falls back to crond.

🧰 Tools

🪛 LanguageTool

[typographical] ~18-~18: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...cOS), resticprofile uses systemd if available, otherwise it falls back to crond. See [refer...

(THUS_SENTENCE)

schedule/handler_darwin_test.go (1)

171-245: New TestParsePrint function.
Parses launchctl output for correctness. Consider adding a scenario for empty or corrupt output if deeper coverage is required.

schedule/handler_darwin.go (2)

243-261: DetectSchedulePermission fallback logic.
Providing a sensible default permission based on whether the process is running as root strengthens reliability. You might consider clarifying or documenting any subtle differences between "logged in" and "logged on" usage to avoid confusion.

326-351: Creating plist files and ensuring correct ownership.
The creation process with MkdirAll at 0o700 is secure. The additional logic handling sudoRoot usage and applying the correct Chown maintains expected file permissions. Consider validating the final file mode if adherence to stricter security is desired.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between edbea57 and fe28b9c.

⛔ Files ignored due to path filters (1)

go.sum is excluded by !**/*.sum

📒 Files selected for processing (67)

.github/workflows/doc.yml (1 hunks)
.github/workflows/release-doc.yml (1 hunks)
.gitignore (1 hunks)
Makefile (2 hunks)
codecov.yml (1 hunks)
commands_schedule_test.go (2 hunks)
constants/value.go (1 hunks)
crond/crontab.go (2 hunks)
crond/crontab_test.go (1 hunks)
crond/entry.go (1 hunks)
crond/entry_test.go (1 hunks)
crond/io.go (1 hunks)
crond/parse_event.go (1 hunks)
crond/parse_event_test.go (1 hunks)
darwin/calendar_interval.go (3 hunks)
darwin/calendar_interval_test.go (1 hunks)
darwin/launchd.go (1 hunks)
darwin/process_type.go (1 hunks)
darwin/process_type_test.go (1 hunks)
darwin/session_type.go (1 hunks)
darwin/session_type_test.go (1 hunks)
darwin/tree.go (1 hunks)
darwin/tree_test.go (1 hunks)
docs/content/schedules/_index.md (2 hunks)
docs/content/schedules/commands.md (1 hunks)
docs/content/schedules/configuration.md (3 hunks)
docs/content/schedules/cron.md (1 hunks)
docs/content/schedules/launchd.md (1 hunks)
docs/content/schedules/systemd.md (5 hunks)
examples/dev.yaml (3 hunks)
examples/linux.yaml (2 hunks)
examples/sample.service (2 hunks)
schedule/calendar_interval_test.go (0 hunks)
schedule/config.go (1 hunks)
schedule/config_test.go (1 hunks)
schedule/handler.go (2 hunks)
schedule/handler_crond.go (7 hunks)
schedule/handler_crond_test.go (5 hunks)
schedule/handler_darwin.go (15 hunks)
schedule/handler_darwin_test.go (7 hunks)
schedule/handler_systemd.go (14 hunks)
schedule/handler_systemd_test.go (4 hunks)
schedule/handler_windows.go (4 hunks)
schedule/handler_windows_test.go (1 hunks)
schedule/job.go (5 hunks)
schedule/job_test.go (5 hunks)
schedule/mocks/Handler.go (8 hunks)
schedule/permission.go (1 hunks)
schedule/permission_test.go (0 hunks)
schedule/permission_unix.go (0 hunks)
schedule/permission_windows.go (0 hunks)
schedule/schedules.go (2 hunks)
schedule/schedules_test.go (1 hunks)
schedule/spaced_title.go (0 hunks)
schedule/spaced_title_test.go (0 hunks)
schedule_jobs.go (1 hunks)
schedule_jobs_test.go (14 hunks)
schtasks/taskscheduler.go (1 hunks)
systemd/generate.go (7 hunks)
systemd/generate_test.go (1 hunks)
systemd/read.go (1 hunks)
systemd/read_test.go (2 hunks)
user/user.go (1 hunks)
user/user_other.go (1 hunks)
user/user_systemd.go (1 hunks)
user/user_test.go (1 hunks)
user/user_windows.go (1 hunks)

💤 Files with no reviewable changes (6)

schedule/spaced_title.go
schedule/calendar_interval_test.go
schedule/spaced_title_test.go
schedule/permission_windows.go
schedule/permission_test.go
schedule/permission_unix.go

🧰 Additional context used

🧬 Code Definitions (23)

user/user_test.go (2)

user/user_other.go (1)

Current (11-39)

user/user_windows.go (1)

Current (9-23)

darwin/session_type_test.go (1)

darwin/session_type.go (1)

NewSessionType (17-32)

systemd/generate_test.go (3)

systemd/generate.go (5)

GetSystemDir (256-258)

Generate (121-222)

Config (94-114)

UnitType (65-65)

SystemUnit (70-70)

config/config.go (1)

Config (28-48)

user/user.go (1)

User (3-9)

user/user_windows.go (2)

user/user_other.go (1)

Current (11-39)

user/user.go (1)

User (3-9)

darwin/launchd.go (3)

darwin/calendar_interval.go (1)

CalendarInterval (23-23)

darwin/process_type.go (1)

ProcessType (7-7)

darwin/session_type.go (1)

SessionType (7-7)

systemd/generate.go (3)

user/user.go (1)

User (3-9)

user/user_other.go (1)

Current (11-39)

user/user_windows.go (1)

Current (9-23)

schedule/handler_windows_test.go (4)

schedule/handler.go (1)

NewHandler (44-49)

schedule/scheduler_config.go (1)

SchedulerWindows (32-32)

schedule/handler_windows.go (1)

HandlerWindows (16-18)

constants/global.go (1)

SchedulerWindows (12-12)

darwin/calendar_interval_test.go (1)

darwin/calendar_interval.go (2)

CalendarInterval (23-23)

ParseCalendarIntervals (119-140)

user/user_other.go (2)

user/user_windows.go (1)

Current (9-23)

user/user.go (1)

User (3-9)

schedule/handler.go (2)

schedule/permission.go (1)

Permission (7-7)

schtasks/permission.go (1)

Permission (13-13)

systemd/read.go (1)

user/user.go (1)

User (3-9)

schedule/handler_crond_test.go (5)

schedule/permission.go (5)

Permission (7-7)

PermissionFromConfig (16-30)

PermissionUserLoggedOn (13-13)

PermissionUserBackground (12-12)

PermissionSystem (11-11)

schedule/handler_crond.go (1)

HandlerCrond (22-25)

systemd/generate.go (1)

Config (94-114)

schedule/config.go (1)

Config (10-27)

schedule/handler.go (1)

NewHandler (44-49)

darwin/process_type.go (1)

constants/value.go (2)

SchedulePriorityBackground (11-11)

SchedulePriorityStandard (12-12)

systemd/read_test.go (3)

systemd/generate.go (3)

Config (94-114)

UnitType (65-65)

SystemUnit (70-70)

schedule/config.go (1)

Config (10-27)

user/user.go (1)

User (3-9)

schedule/job.go (1)

schedule/permission.go (2)

PermissionFromConfig (16-30)

Permission (7-7)

darwin/session_type.go (1)

constants/value.go (4)

SchedulePermissionSystem (6-6)

SchedulePermissionUser (7-7)

SchedulePermissionUserLoggedOn (8-8)

SchedulePermissionUserLoggedIn (9-9)

schedule/handler_windows.go (3)

schedule/config.go (1)

Config (10-27)

schedule/permission.go (5)

Permission (7-7)

PermissionUserBackground (12-12)

PermissionUserLoggedOn (13-13)

PermissionAuto (10-10)

PermissionSystem (11-11)

schtasks/permission.go (3)

Permission (13-13)

SystemAccount (18-18)

UserAccount (17-17)

crond/crontab.go (1)

user/user_other.go (1)

Current (11-39)

schedule/mocks/Handler.go (2)

schedule/handler.go (1)

Handler (12-29)

schedule/permission.go (1)

Permission (7-7)

schedule/permission.go (1)

constants/value.go (5)

SchedulePermissionSystem (6-6)

SchedulePermissionUser (7-7)

SchedulePermissionUserLoggedIn (9-9)

SchedulePermissionUserLoggedOn (8-8)

SchedulePermissionAuto (5-5)

schedule/handler_systemd.go (4)

systemd/generate.go (2)

Config (94-114)

UnitType (65-65)

schedule/config.go (1)

Config (10-27)

schedule/permission.go (5)

Permission (7-7)

PermissionFromConfig (16-30)

PermissionSystem (11-11)

PermissionUserBackground (12-12)

PermissionUserLoggedOn (13-13)

schedule/handler.go (1)

Handler (12-29)

schedule/handler_darwin_test.go (7)

darwin/calendar_interval.go (1)

GetCalendarIntervalsFromSchedules (67-73)

darwin/launchd.go (1)

LaunchdJob (7-100)

constants/value.go (1)

SchedulePermissionUserLoggedOn (8-8)

schedule/handler.go (1)

NewHandler (44-49)

schedule/scheduler_config.go (1)

SchedulerLaunchd (37-37)

constants/global.go (1)

SchedulerLaunchd (11-11)

schedule/handler_darwin.go (1)

HandlerLaunchd (47-50)

schedule/handler_darwin.go (8)

schedule/config.go (1)

Config (10-27)

schedule/permission.go (5)

Permission (7-7)

PermissionFromConfig (16-30)

PermissionSystem (11-11)

PermissionUserBackground (12-12)

PermissionUserLoggedOn (13-13)

schedule/errors.go (1)

ErrScheduledJobNotFound (7-7)

darwin/launchd.go (1)

LaunchdJob (7-100)

darwin/calendar_interval.go (1)

GetCalendarIntervalsFromSchedules (67-73)

darwin/process_type.go (2)

ProcessType (7-7)

NewProcessType (14-25)

darwin/session_type.go (1)

NewSessionType (17-32)

user/user.go (1)

User (3-9)

🪛 YAMLlint (1.35.1)

examples/linux.yaml

[warning] 105-105: wrong indentation: expected 12 but found 10

(indentation)

🪛 LanguageTool

docs/content/schedules/configuration.md

[uncategorized] ~76-~76: Loose punctuation mark.
Context: ...user, or user_logged_on: * system: Access system or protected files. Run r...