support task-schema refactor

[yyscamper]

Change including:
(1) Task-Definition: replace schemaRef with optionsSchema, optionsSchema can be either string or object, so set its type to json.
(2) add removeSchema API for JSON schema validator;

@RackHD/corecommitters @iceiilin @pengz1 @cgx027 @lanchongyizu @amymullins

[brianparry]

Hi @yyscamper. I'm curious where this PR stands at the moment. Do you intend to make any additional changes such as those we discussed during your visit?

[yyscamper]

@brianparry No additional change, I was trying to resolve the conflict and rebase my code to make sure the dependency Jenkins passes, then I will base on this code to do stress testing. This is the reason why you see the Jenkins becomes active again.

[cgx027]

Looks good to me. 👍

[JenkinsRHD]

BUILD on-core #964 : FAILURE

• ** BUILD build-config-setup #201131: SUCCESS

• ** BUILD unit-tests #10505: SUCCESS

• ** BUILD smoke-test #3961: FAILURE

• ** BUILD on-taskgraph #1830: SUCCESS

  • ** BUILD build-config-setup #201132: SUCCESS
  • ** BUILD unit-tests #10506: SUCCESS

• ** BUILD on-http #2959: SUCCESS

  • ** BUILD build-config-setup #201133: SUCCESS
  • ** BUILD unit-tests #10507: SUCCESS

• ** BUILD on-dhcp-proxy #1032: SUCCESS

  • ** BUILD build-config-setup #201134: SUCCESS
  • ** BUILD unit-tests #10508: SUCCESS

• ** BUILD on-tasks #1813: SUCCESS

  • ** BUILD build-config-setup #201135: SUCCESS
  • ** BUILD unit-tests #10509: SUCCESS

• ** BUILD on-tftp #814: SUCCESS

  • ** BUILD build-config-setup #201136: SUCCESS
  • ** BUILD unit-tests #10510: SUCCESS

• ** BUILD on-syslog #746: SUCCESS

  • ** BUILD build-config-setup #201137: SUCCESS
  • ** BUILD unit-tests #10511: SUCCESS

[changev]

test this please

[JenkinsRHD]

BUILD on-core #966 : FAILURE

• ** BUILD build-config-setup #201193: SUCCESS

• ** BUILD unit-tests #10516: FAILURE

• ** BUILD on-taskgraph #1832: FAILURE

  • ** BUILD build-config-setup #201194: SUCCESS
  • ** BUILD unit-tests #10517: FAILURE

[PengTian0]

test this please

[changev]

test this please

[brianparry]

@yyscamper The change looks good, so 👍 , but I think we should consider adding parameter constraints inline with task definition properties rather than defining a seperate schema property. One way to think about this is that the task definitions themselves would be a kind of schema. I think this would make writing task definitions easier for users.

[yyscamper]

@brianparry : Thanks for your review. But I don't quite understand your comment, whether you mean the schema should go along with each option rather than put together in a separate property? Something like below?

{
    injectableName: 'Task.InstallCentOS',
    friendlyName: 'CentOS install',
    options: {
        version: {
            type: 'string',
            required: true
        },
        repo: {
            type: 'string',
            required: true,
            default: '{{api.server}}/centos/{{options.version}}'
        }
    }
}

I did think about this, the challenge is it cannot or hard meet some complex case, for example, for LinuxCommand task, the command can either be a string or an object, so it should look like

options: {
  command: {
     oneOf:[
        { 
           type: 'string'
        },
        { 
           type: 'object',
           properties: {
              ...
           }
        }
     ]
  }
}

It just like one task definition contains multiple sub json schema. For my case, all sub json schemas are contained in the seperated key optionsSchema.

Another reason is for some complex required case, for example, the CreateMegaRaid task can either be choosed to create default RAID or create user customized RAID, the required looks like:

oneOf: [
    { 'required': ['controllerId', 'createDefault'] }
    { 'required': ['controllerId', 'raidConfig'] }
]

This kind of constraint applies for the whole of options rather than a single option.

Put all constraints together gives us the flexibility to use all JSON schema capability. Split the whole schema into multiple sub schemas does have some constraints to handle some complex case.

If you have better solution to resolve above complex case that will be very welcome.

[iceiilin]

+1