[Feature]: Have tcr check subcommand verify perforce environment

[mengdaming]

Contact Details

damien.menanteau@gmail.com

Feature Request

Current TCR implementation does not check any perforce-related configuration and environment when running TCR with perforce.

Objective is to make sure everything p4-related is ready / properly configured when running with --vcs=p4 option.

Feature Description

TBC

Alternatives

N/A

Additional Context

N/A

Code of Conduct

• I agree to follow this project's Code of Conduct

To Do

• tcr check command runs reports all p4-specific checks
  • run VCS-specific checks depending on the VCS being used by TCR (git or p4)
  • p4 command
    • look for it in the path
      • if present, report full path
      • if not present -> error
    • display p4 command version?
  • p4 client/workspace
    • retrieve it from p4 info
      • if set, report its value
      • if not set -> error
  • p4 root directory
    • retrieve it from p4 info
      • if set, report its value
      • if not set -> error
    • check if TCR base dir is under p4 root dir
      • report error if not
    • check if TCR work dir is under p4 root dir
      • report error if not
  • other p4 info. Do we want to display them?
    • User Name
    • Client host
    • Current directory
    • Peer address
    • Client address
    • Server address
    • Server root
    • Server date
    • Server uptime
    • Server version
    • ServerID
    • Server services
    • Server license
    • Server license-ip
    • Case Handling
• Test on other machines
• Test isSubPath

Parking

• Move the function isSubPath to a utility package
  • Do the path cleaning in the isSubPath method instead of outside
• Discuss about how to test