iganaq/ocaml/TODO.md

• Spec requirements integration test coverage

  • Add log function
    • Output begins with [log]
    • Only prints if DEBUG is set
  • Add interactive pkg tests (INS v0 B2.5)
    • Get su command from $XDG_CONFIG_HOME/tori/tori.conf
      • Default to su -c
      • Validation
        • Valid path or in PATH
        • Executability
        • [-] true exits with status 0 (see note 3)
    • Add logging
      • Logs only if DEBUG is set
      • Print each command executed, not just package names
    • Case with no packages provided
      • Prints a message
      • MUST NOT run any system commands
  • Unrecognized command: exit code 1
  • Command user: print the output of whoami
  • Command os: print the OS name
    • log the contents of /etc/os-release

• Refactorings

  • Simplify and analyze System.File
  • Simplify Reader

• Additionals

  • Create interface files
  • Expand unit tests coverage
  • Try out doc generation

Notes

1. INS = Iganaq Napkin Spec: https://brew.bsd.cafe/tori/iganaq#specification
2. INS v0 B2.5 "MUST NOT run any system commands" is only testable if we wrap command execution properly in e.g. a list containing all executed commands and ensure no command is ever executed without being appended to it
3. INS v0 A3.4 "running 'true' with exit code 0" requires the user to input their password every time. This should be dropped from the spec instead
4. INS v0.1 changes requirement B2.3 to "MUST print the OS name and MUST log contents of /etc/os-release" in order to make the logging function testable without user input.