Uploaded image for project: 'Nuxeo Platform'
  1. Nuxeo Platform
  2. NXP-23071

Use parameter-name for nuxeoctl register-trial

    XMLWordPrintable

    Details

      Description

      Context

      Command "nuxeoctl register-trial" has changed in version Nuxeo Server 9.2, where the new syntax takes exactly 5 arguments as the old syntax:

      Old syntax (since 8.3): nuxeoctl register-trial [<email> <company> <project> <description> [<pwd>]]
      New syntax (since 9.2): nuxeoctl register-trial [<firstname> <lastname> <email> <company> <project>]
      

      It breaks the compatibility. Using the new register-trial by giving the old syntax, the first name will be filled as email, company will be filled as last name, etc. In order to keep the compatibility, we need to re-design the command line to avoid any kind of ambiguity.

      It has been suggested to merge "register" and "register-trial".
      Meanwhile, notice that registering instance and registering trial (user) currently accept completely different parameters, so merging "register" and "register-trial" might not be easy.

      Proposal

      My proposal is to keep using command register-trial, but add name for each parameter. Here's the syntax of my proposal:

      nuxeoctl register-trial [PARAMS]...
      

      Where parameters are given as a table:

      Parameter Name Description
      --first=[FIRST_NAME] First name of the user
      --last=[LAST_NAME] Last name of the user
      --email=[EMAIL] Email of the user
      --company=[COMPANY] Company of the user
      --project=[PROJECT] Name of the project

      Here's the list of requirements about register-trial:

      1. Version compatible. The command line must be version-compatible. => Parameter-matching should be explicit, because implicit matching break version compatibility as explained in the previous paragraph
      2. Unordered. The new command line should not care parameter order, "--A=a --B=b" and "--B=b --A=a" are equivalent.
      3. Migration. Using register-trial without parameter-names can work, we assume the parameter order are: first-name, last-name, email, company, project. A warning will show to suggest the migration to typed options.
      4. Documentation. The documentation should be updated accordingly: see nuxeoctl and Control Panel Usage

        Attachments

          Issue Links

            Activity

              People

              • Votes:
                1 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: