Add support for escalating SDWs to Errors

[olabusayoT]

• add tunable 'escalateWarningsToErrors' to control escalation of all warnings to errors
• add test to demonstrate tunable

DAFFODIL-2810

[stevedlawrence]

+1 👍

[stevedlawrence]

Should this be toss(sde)? I think error will just record it but wont' cause immediate failure and could continue.

[stevedlawrence]

Should we include the warnID so that a user could know what to suppress if they want to suppress a particular warning?

Is there any value in in a new type of SDE like this:

val sdw = ... 
val sde = new SchemaDefinitionErrorFromWarning(sdw)

Note a fan of the name, but then the logic for displaying the warn id is exactly the same regardless of if it's escalated or not. And if we ever change how warnings work we don't really have to change this.

Not sure if adding an extra SDE class that wraps an SDW gets messy though...

[olabusayoT]

I think includinf the warnID is a great idea

To add a new SDE class that supports both RuntimeSDW and regular SDW, we'd need to expose the arguments of SchemaDefinitionDiagnosticBase (SDDB) and make sure we can access them from the passed in sdw. Is this acceptable? I'm thinking adding vals to the args of SDDB and then doing something like:

class SchemaDefinitionErrorFromWarning(
  sdw: SchemaDefinitionDiagnosticBase
) extends SchemaDefinitionError(
  (if (sdw.sc.isDefined) Some(sdw.sc.get) else None),
...
) {

[stevedlawrence]

Yeah, something like that could probably work.

Another approach, could maybe just extend SchemaDefinitionWarning, and overide a few memers,e.g

class SchemaDefinitionErrorFromWarning(...) extends SchemaDefinitionWarning(...) {
  override def isError = "true"
  override def modeName = super.modeName + " Escalated"
}

I'm not sure what the best appraoch is, but something that can minimize duplication and will automatically inherit any future changes made to SDW would be nice.

[stevedlawrence]

Can this sdw have the type of SchemaDefinitionWaring instead of SchemaDefinitionDiagnosticBase? This should only be used for warnings so seems like that would be on okay limitation? And would that simplify the extends at all? For example, we wouldn't need to pass in warnID since that's already available in sdw. Maybe it just becomes something like:

SchemaDefinitionErrorFromWarning(
  sdw: SchemaDefinitionWarning
) extends SchemaDefinitionWarning(
    sdw.warnId,
    sdw.schemaContext,
    sdw.annotationContext,
    sdw.kind,
    sdw.args
  )

Keeps things as simple as possible and makes the warning message the exact same as a normal warning, just with a different mode name to make it clear it's been escalated to an error?

[olabusayoT]

I don't think this would work for RuntimeSchemaDefinitionWarning since it extends SchemaDefinitionDiagnosticBase rather than SchemaDefinitionWarning

[stevedlawrence]

We could probably change it to extend SDW if it makes sense.

[olabusayoT]

Done...I also made RSDE an SDE to keep things consistent

[stevedlawrence]

I think the modeName is already "Schema Definition Warning Escalated Error". Could we remove the duplicate "warning escalated to error" in the message?

[jadams-tresys]

+1

[jadams-tresys]

Just curious if this was auto-formatted to move everything to a new line. Seems a little over-zealous in this case to me.

[olabusayoT]

Oh no, I just wrote it that way...it wasn't autoformatted to look like that. I can change it to one line tho

[jadams-tresys]

+1