{"id":2931,"date":"2019-09-18T18:12:39","date_gmt":"2019-09-18T06:12:39","guid":{"rendered":"https:\/\/www.deltics.co.nz\/blog\/?p=2931"},"modified":"2019-09-18T20:56:05","modified_gmt":"2019-09-18T08:56:05","slug":"sorry-this-script-is-too-long","status":"publish","type":"post","link":"https:\/\/www.deltics.co.nz\/blog\/posts\/2931\/","title":{"rendered":"‘Sorry, this script is too long…’"},"content":{"rendered":"[Estimated Reading Time: <\/span> 6<\/span> minutes]<\/span><\/span>\n

If Mark Twain was hired to write error messages for the Azure DevOps team, he might have deployed his own, suitably paraphrased quote, completing it with… ‘Perhaps you should take some time to make it shorter ?<\/em>‘<\/p>\n\n\n\n\n\n\n\n

I’ve been wrestling with a problem today with my Delphi build template that is a classic case of misdirection and inadequate error handling (or rather, unhelpful, unadorned error messages being passed to the end-user without further explanation or suggestion).<\/p>\n\n\n\n

A bit of background…<\/p>\n\n\n\n

As noted before, much of the Delphi<\/strong> work I have done (and am returning to) involves supporting many different versions of Delphi, from Delphi 7 to current. As a result, my CI\/CD pipelines need to build code with all of those Delphi versions and (increasingly) run tests to exercise it.<\/p>\n\n\n\n

So I was making changes to my build template to enable me to pass in an array of Delphi<\/strong> versions and have it perform builds for all those versions.<\/p>\n\n\n\n

This comes with some downsides, which we’ll perhaps come back to. But my initial problem was how to achieve it.<\/p>\n\n\n\n

I first decided to try Iterative Insertion<\/strong><\/a>, as this seemed to be suited to the job. That is, I wanted to create a further template which would iteratively insert into itself the steps needed to in-turn invoke my build template for each Delphi<\/strong> version that I specified.<\/p>\n\n\n\n

My goal was to be able replace a list of over a dozen individual build steps with just one. To give you some idea, consider a build involving just 3 Delphi versions (let’s say 7, 2007 and 10.3 Rio for example):<\/p>\n\n\n\n

- template: delphi-build.yml@templates\n  parameters:\n    delphiVersion: 7\n    project: tests\\tests\n    preBuildInline: duget restore --noUnpack\n    postBuildInline: .bin\\tests -f=.results\\delphi.7.xml\n- template: delphi-build.yml@templates\n  parameters:\n    delphiVersion: 2007\n    project: tests\\tests\n    preBuildInline: duget restore --noUnpack\n    postBuildInline: .bin\\tests -f=.results\\delphi.2007.xml\n- template: delphi-build.yml@templates\n  parameters:\n    delphiVersion: 10.3\n    project: tests\\tests\n    preBuildInline: duget restore --noUnpack\n    postBuildInline: .bin\\tests -f=.results\\delphi.10.3.xml\n- etc<\/code><\/pre>\n\n\n\n
The goal was to be able to achieve the same thing with just this one step:<\/p>\n\n\n\n
- template: delphi-builds.yml@templates\n  parameters:\n    delphiVersion: 7 2007 10.3\n    project: tests\\tests\n    preBuildInline: duget restore --noUnpack\n    postBuildInline: .bin\\tests -f=.results\\delphi.$($delphiVersion).xml<\/code><\/pre>\n\n\n\n
Neat, huh ?<\/p>\n\n\n\n
Long story short, I could not figure out how to do this with Iterative Insertion<\/strong>. The ‘error messages’ from the YAML processor were less than helpful and I couldn’t find anyone doing anything similar using this approach.<\/p>\n\n\n\n
So I tried coming at it from a different angle.<\/p>\n\n\n\n
Instead of trying to dynamically generate a template to call another template, I used the dynamic nature of Powershell<\/strong> itself.  After an initial struggle, trying to figure out how to pass an array of Delphi<\/strong> versions as a parameter to a template and then have that picked up as an array of strings by Powershell<\/strong>, I realised that it was far simpler than that.<\/p>\n\n\n\n
The simple string syntax already gave me everything I wanted and needed.  Since YAML does not require string values to be quoted, simply passing a space-separated list of values did the job and was actually cleaner anyway.<\/p>\n\n\n\n
This meant that my target syntax could actually be supported directly by my existing template:<\/p>\n\n\n\n
- template: delphi-build.yml@templates\n  parameters:\n    delphiVersion: 7 2007 10.3\n    project: tests\\tests\n    preBuildInline: duget restore --noUnpack\n    postBuildInline: .bin\\tests -f=.results\\delphi.$($delphiVersion).xml<\/code><\/pre>\n\n\n\n
All I needed to do was refactor the Powershell<\/strong> script in that template to create a function<\/em> to perform the build with the script itself becoming a processor which turned the delphiVersion<\/code><\/strong> parameter into an array and then called that build function iteratively for each version in that array (i.e. each version space separated in the parameter).<\/p>\n\n\n\n
Neat.<\/p>\n\n\n\n
A few short moments later I had an almost working script.  The only problem I had was that I forgot to deal with one important side effect of now calling this script effectively multiple times.<\/p>\n\n\n\n
The script set the working location for the build to the folder containing the project being compiled.  When building for multiple Delphi versions this worked fine for the very first version compiled and then failed miserably for all subsequent compilations because the subsequent invocations of the build function were starting<\/em> in that location rather than the root<\/em> of the repo.<\/p>\n\n\n\n
No problem, one of the great things about Powershell is that it features many of the capabilities that we’re used to in other programming languages.  In this case the familiar try<\/code>\/finally<\/code> was the tool I reached for.<\/p>\n\n\n\n
Before calling Set-Location<\/code> to change the current directory, simply stash the result of Get-Location<\/code>, wrap the important parts of the build process in a try<\/code> \/ finally<\/code> and call Set-Location<\/code> again in the finally<\/code> to restore the previous location.<\/p>\n\n\n\n
What could be simpler ?<\/p>\n\n\n\n
This simple change completely broke my script.  And I mean:  Completely<\/em>.<\/p>\n\n\n\n
The pipeline started complaining that my try<code> block was missing a <\/code>catch<\/code> or finally<\/code> (it obviously wasn’t).  I tidied up some of my formatting inconsistencies, just on the off-chance that there was something in there throwing things off with my bracketing (though there were no complaints on that score).<\/p>\n\n\n\n
Ooops.  Spoke too soon.  Although I had not introduced or removed any bracketing in my tidy ups, suddenly my pipeline started complaining that my {}<\/code>‘s were mis-matched.<\/p>\n\n\n\n
After painstakingly re-assuring myself that this wasn’t the case (it wasn’t) I turned my suspicious gaze on YAML whitespace indentation – this had caught me out before.<\/p>\n\n\n\n
All in vain.<\/p>\n\n\n\n
But I had undertaken more tidying up along the way and now Azure DevOps<\/strong> itself was complaining.  Up to now the errors had occurred when the build job reached my step on the build machine and executed the Powershell.  Now Azure DevOps was point-blank refusing to even start a run.  Now there was some issue right at the top, line 17 to be precise, the very beginning of the script step.  And now the problem was something about not being able to ‘convert from an array to a string<\/em>‘.<\/p>\n\n\n\n
I was clearly getting nowhere trying to fix the script as it stood.  In fact, going backwards!<\/p>\n\n\n\n
Not being able to make sense of the errors, I decided to re-construct the entire script piece by piece.  Stripping it back to nothing then adding chunks of functionality a few lines at a time until it broke.  The idea was that this would help me identify where<\/em> exactly in the script the problem was and so hopefully make it easier to spot.<\/p>\n\n\n\n
This started well, with my script instantly back to glowing health, even if not doing very much.  In fact, I got all the way to the final dozen or so lines of code before it broke.  These final few lines were simple stuff so figuring out where the problem was should be simple.<\/p>\n\n\n\n
The bad news: Yes, these lines were indeed very<\/em> simple.  There was clearly and self-evidently nothing wrong with them at all<\/em>.<\/p>\n\n\n\n
Yet, without those 12 lines my script compiled and ran just fine.  With them, it would not even run.<\/p>\n\n\n\n
On a nervous hunch, I added them back in, but commented them out.<\/p>\n\n\n\n
And still the pipeline would not run<\/em>.<\/p>\n\n\n\n
Conclusion: <\/strong>The problem was not caused by anything the code was doing – commented out code doesn’t do anything.  The problem was simply the code being there at all!<\/em><\/p>\n\n\n\n
There was one thing that might explain both the errors I was seeing before and this new discovery: An upper limit on the length of a script that can be included in an Azure Pipeline step!<\/em><\/p>\n\n\n\n
And sure enough, there appears to be such a limit.<\/p>\n\n\n\n
The different error messages were presumably the result of this limit being run into at different stages in the process.<\/p>\n\n\n\n
If the “raw” script itself was too big, then the problem of not being able to convert an array to a string<\/em> presumably comes from the pipeline trying to parse the template itself.<\/p>\n\n\n\n
But if the raw script was just within the limit, the problem might then have been caused when substitutions and insertions were applied (e.g. the preBuildInline<\/code> and postBuildInline<\/code> script fragments that my consuming pipeline inserted).  This may have pushed the script over the bounds of whatever buffer was being used to prep it.  This truncated buffer was then being passed on to the build agent where Powershell<\/strong> itself would then choke on the syntax errors caused by that truncation.  Those errors would vary according to where the truncation had occurred, and none of them would make sense when considered in the context of the whole script.<\/p>\n\n\n\n
It all started to make sense, but why oh why could there not have been a straightforward error message to tell me that this length limit had been exceeded!? It would have saved me hours!<\/p>\n\n\n\n
From subsequent digging through forums and the like, it seems that the limit is 5,000 characters.  This seems more or less consistent with my own observations.  It\u2019s difficult to be very precise as the use of substitutions and insertions in a template seem to be a contributing factor.  i.e. it\u2019s not only a question of how many characters there are in the script source in a template or step, but the total characters after any substitutions have taken place.<\/p>\n\n\n\n
Be that as it may, all I have to do now is figure out how to scrunch this script down without making it impenetrable and retaining the functionality I want and need.<\/p>\n\n\n\n
Let this be a lesson in the utility of helpful error messages (and the unnecessary pain that can be caused by their omission).<\/p>\n\n\n\n
Footnote: <\/strong>I mentioned that building with multiple versions of Delphi<\/strong> in a single step has a downside.  Well, it is this: Since all of the compilations with the various Delphi versions specified are performed in a single step, the resulting output from the build pipeline can only tell me that Delphi<\/strong> compilation failed.  I then need to scour through the logs of that one step to figure out which<\/em> Delphi versions failed.  Iterative Insertion<\/strong> would avoid that by creating separate steps for each Delphi version, so it was a real shame that I couldn’t get that to work.  So for now, I’m going to keep the multiple Delphi version support for some perhaps limited occasions when it may be useful, but use a different trick to keep my main pipelines trimmed to a minimum.<\/p>\n","protected":false},"excerpt":{"rendered":"
[Estimated Reading Time: <\/span> 6<\/span> minutes]<\/span><\/span> An object lesson on the importance of defensive programming and providing helpful error messages to your users.<\/p>\n","protected":false},"author":2,"featured_media":2932,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"jetpack_post_was_ever_published":false,"jetpack_publicize_message":"","jetpack_is_tweetstorm":false,"jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":true,"jetpack_social_options":[]},"categories":[322,323,4,321,1],"tags":[326,292,328,338],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"https:\/\/i0.wp.com\/www.deltics.co.nz\/blog\/wp-content\/uploads\/Mark_Twain_life_1900s.jpg?fit=883%2C331&ssl=1","jetpack_shortlink":"https:\/\/wp.me\/p1TKYv-Lh","jetpack_sharing_enabled":true,"jetpack-related-posts":[{"id":2659,"url":"https:\/\/www.deltics.co.nz\/blog\/posts\/2659\/","url_meta":{"origin":2931,"position":0},"title":"Azure DevOps and Delphi – Build Agents","date":"06 Sep 2019","format":false,"excerpt":"The first in a series of posts exploring build and test automation for Delphi projects using Azure DevOps.","rel":"","context":"In "automation"","img":{"alt_text":"","src":"https:\/\/i0.wp.com\/www.deltics.co.nz\/blog\/wp-content\/uploads\/pipelines-hero-1-1024x256.jpg?fit=1024%2C256&ssl=1&resize=350%2C200","width":350,"height":200},"classes":[]},{"id":2861,"url":"https:\/\/www.deltics.co.nz\/blog\/posts\/2861\/","url_meta":{"origin":2931,"position":1},"title":"Azure DevOps – Building Some Code","date":"09 Sep 2019","format":false,"excerpt":"In this post we create a (very!) simple project, build it using Delphi (7) and run it. All with Azure DevOps.","rel":"","context":"In "automation"","img":{"alt_text":"","src":"https:\/\/i0.wp.com\/www.deltics.co.nz\/blog\/wp-content\/uploads\/pipelines-hero-code-1024x256.jpg?fit=1024%2C256&ssl=1&resize=350%2C200","width":350,"height":200},"classes":[]},{"id":2919,"url":"https:\/\/www.deltics.co.nz\/blog\/posts\/2919\/","url_meta":{"origin":2931,"position":2},"title":"Azure DevOps – Now You Too Can Use My Template(s)","date":"14 Sep 2019","format":false,"excerpt":"Learn how you too can use my Delphi build template in your own Azure DevOps pipelines, and a sneak preview of something special coming soon...","rel":"","context":"In "automation"","img":{"alt_text":"","src":"https:\/\/i0.wp.com\/www.deltics.co.nz\/blog\/wp-content\/uploads\/github-512.png?fit=512%2C512&ssl=1&resize=350%2C200","width":350,"height":200},"classes":[]},{"id":2936,"url":"https:\/\/www.deltics.co.nz\/blog\/posts\/2936\/","url_meta":{"origin":2931,"position":3},"title":"Azure DevOps – Iterative Insertion Fixed!","date":"19 Sep 2019","format":false,"excerpt":"I figured out the iterative insertion problem and my build pipeline is now TIGHT! Fixing it was super-easy in fact, barely an inconvenience.","rel":"","context":"In "automation"","img":{"alt_text":"","src":"https:\/\/i0.wp.com\/www.deltics.co.nz\/blog\/wp-content\/uploads\/pipelines-hero-code-1024x256.jpg?fit=1024%2C256&ssl=1&resize=350%2C200","width":350,"height":200},"classes":[]},{"id":2878,"url":"https:\/\/www.deltics.co.nz\/blog\/posts\/2878\/","url_meta":{"origin":2931,"position":4},"title":"Azure DevOps – Template for Builds + Running Tests and Capturing Results","date":"12 Sep 2019","format":false,"excerpt":"A more complete build script, re-usable in the form of a template, that caters for different Delphi versions, combined with a demonstration of running unit tests and capturing results for reporting and analysis in Azure DevOps Pipelines.","rel":"","context":"In "automation"","img":{"alt_text":"","src":"https:\/\/i0.wp.com\/www.deltics.co.nz\/blog\/wp-content\/uploads\/Screen-Shot-2019-09-12-at-14.25.20.jpg?fit=386%2C386&ssl=1&resize=350%2C200","width":350,"height":200},"classes":[]},{"id":2968,"url":"https:\/\/www.deltics.co.nz\/blog\/posts\/2968\/","url_meta":{"origin":2931,"position":5},"title":"Azure DevOps + GitHub = GitHub++","date":"23 Sep 2019","format":false,"excerpt":"A look at some of the integrations that \"just work\" when you combine Azure DevOps and GitHub","rel":"","context":"In "automation"","img":{"alt_text":"","src":"https:\/\/i0.wp.com\/www.deltics.co.nz\/blog\/wp-content\/uploads\/azure-devopsgithub.png?fit=1024%2C341&ssl=1&resize=350%2C200","width":350,"height":200},"classes":[]}],"_links":{"self":[{"href":"https:\/\/www.deltics.co.nz\/blog\/wp-json\/wp\/v2\/posts\/2931"}],"collection":[{"href":"https:\/\/www.deltics.co.nz\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.deltics.co.nz\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.deltics.co.nz\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.deltics.co.nz\/blog\/wp-json\/wp\/v2\/comments?post=2931"}],"version-history":[{"count":3,"href":"https:\/\/www.deltics.co.nz\/blog\/wp-json\/wp\/v2\/posts\/2931\/revisions"}],"predecessor-version":[{"id":2935,"href":"https:\/\/www.deltics.co.nz\/blog\/wp-json\/wp\/v2\/posts\/2931\/revisions\/2935"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.deltics.co.nz\/blog\/wp-json\/wp\/v2\/media\/2932"}],"wp:attachment":[{"href":"https:\/\/www.deltics.co.nz\/blog\/wp-json\/wp\/v2\/media?parent=2931"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.deltics.co.nz\/blog\/wp-json\/wp\/v2\/categories?post=2931"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.deltics.co.nz\/blog\/wp-json\/wp\/v2\/tags?post=2931"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}