search

pcdshub / pytmc

Generate EPICS IOCs and records from TwinCAT projects - along with many TwinCAT project tools
https://pcdshub.github.io/pytmc/
Other
10 stars 11 forks source link

Record length linting does not consider macro substitutions #309

Open ZLLentz opened 1 year ago

ZLLentz commented 1 year ago

The following records in my project may or may not be above length 60, but the linter can't actually know because "$(PREFIX)" will be subbed out.

pytmc.bin.db.LinterError: Records exceeding the maximum length of 60 were found:
    $(PREFIX):SIM:XPIM:ZOOM:PLC:stEPSBackwardEnable:sFlagDesc_RBV
    $(PREFIX):SIM:XPIM:FOCUS:PLC:stEPSBackwardEnable:sFlagDesc_RBV
    $(PREFIX):SIM:XPIM:FOCUS:PLC:stEPSBackwardEnable:sMessage_RBV
    $(PREFIX):SIM:XPIM:FOCUS:PLC:stEPSForwardEnable:sFlagDesc_RBV
    $(PREFIX):SIM:XPIM:MMS:STATE:PMPS:TRANS:BP:BeamClassRanges_RBV

The current behavior is to assume the replaced string is the same length as the macro string. In this case, the prefix is assumed to be 9 characters long. The PLC prefix is actually length 11 in this case, which means the linter check here probably misses additional records that are also above length 60. (In my case, I definitely need to trim some prefix off)

My worry is that for similar cases the linter is failing to catch the maximum length check and letting through some records that will be too long after a macro substitution.

klauer commented 1 year ago

A duplicate of https://github.com/pcdshub/pytmc/issues/254 but described here in much better detail.

As you say, we can't really know until the IOC boots up and subs in macros. I'm not sure of a good path forward for this and am definitely open to suggestions.

ZLLentz commented 1 year ago

I searched for old issues but didn't search well enough, whoops

ZLLentz commented 1 year ago

My main ideas are:

klauer commented 1 year ago

So - "if macro included and non-macro part is about 50 chars, warn"?

I think that's pretty reasonable, though I'm not sure how it would get back to the user. Errors are easy because the linter fails with a specific return code in an obvious fashion, whereas warnings require someone to be paying attention to the output even in the case of success.

Integrated with GHA, annotating a specific line wouldn't be easy to implement. Warnings in the summary output would be OK - but would remain somewhat hidden. Hmm...

ZLLentz commented 1 year ago

Maybe simplest is we go around to all the prod configs, see which macros are in use, and then see how long the substitutions typically are. Then in the linter it's straightforward, we automatically sub in $(PREFIX) -> 12 characters or whichever the longest is plus some buffer.

I'd rather this error extra than not enough and PV names at around 57 should still be shortened.

ZLLentz commented 1 year ago

Another option is to allow some level of macro sub length checking based on input args during make