Exit batch files explictly using ERRORLEVEL #29583

Mpdreamz · 2018-04-18T14:01:29Z

This makes sure the exit code is preserved when calling the batch
files from different contexts other than DOS

Fixes #29582

elasticmachine · 2018-04-18T14:25:45Z

Pinging @elastic/es-core-infra

rjernst · 2018-05-20T19:25:57Z

@Mpdreamz Do you want to bring this PR up to date? There are a number of new bat files now that xpack has been opened.

Mpdreamz · 2018-05-21T00:23:58Z

Yes, on vacay in Japan now won't be back for another week.

javanna · 2018-08-16T13:20:55Z

ping @Mpdreamz

Mpdreamz · 2018-10-30T13:05:55Z

I've updated this PR and also fixed cases where we were always setting the exit code to 1 in case of an error.

e.g currently bin\elasticsearch-shard.bat always returns 1 while the cli tool itself is returning the more useful 64 exit code

cc @elastic/es-core-infra @elastic/microsoft

jasontedor

I left a question.

jasontedor · 2018-11-02T00:04:12Z

distribution/src/bin/elasticsearch-keystore.bat

-call "%~dp0elasticsearch-cli.bat" ^
-  %%* ^
-  || exit /b 1
+call "%~dp0elasticsearch-cli.bat" %%* 


Is there a reason this wouldn't work? Then we can keep the exit close to the failing script, we really do want to error out immediately here.

Suggested change

call "%~dp0elasticsearch-cli.bat" %%*

call "%~dp0elasticsearch-cli.bat" ^

%%* ^

|| exit /b %errorlevel%

Thanks for the review @jasontedor, finally took the effort to get back to this PR.

Sadly we need the exit /b %errorlevel% after the endlocal calls otherwise it does not survive in a non CMD context.

I also tried the special :eof label as documented here

call "%~dp0elasticsearch-cli.bat" %%* || goto :eof

We could get rid of the endlocal calls alltogether since the local context is automatically closed when the bat file exits but non CMD contexts still need the explicit exit /B

I will update the PR with the following:

call "%~dp0elasticsearch-cli.bat" %%* || goto exit endlocal endlocal :exit exit /B %ERRORLEVEL%

Which I think makes the early exit explicit and satisfies carrying over the exit code to non CMD contexts.

jasontedor · 2018-11-02T00:04:15Z

distribution/src/bin/elasticsearch-keystore.bat


 endlocal
 endlocal
+exit /b %ERRORLEVEL%


Suggested change

exit /b %ERRORLEVEL%

jasontedor · 2018-12-19T17:40:05Z

distribution/src/bin/elasticsearch-keystore.bat

-call "%~dp0elasticsearch-cli.bat" ^
-  %%* ^
-  || exit /b 1
+call "%~dp0elasticsearch-cli.bat" %%* || goto exit


Would you maintain the line breaks that we have? It keeps these scripts looking the same as the Unix scripts too.

jasontedor

I left one request, about the line breaks.

Mpdreamz · 2019-01-08T14:12:36Z

@jasontedor, updated the linebreaks on the bat files to match the unix scripts.

Mpdreamz · 2019-01-24T13:32:17Z

Test this please

jasontedor

There are two new scripts:

elasticsearch-node
elasticsearch-shard

Would you address those as well please? Otherwise this looks good. Thanks for picking this up.

This makes sure the exit code is preserved when calling the batch files from different contexts other than DOS Fixes elastic#29582 This also fixes specific error codes being masked by an explict exit /b 1 causing the useful exitcodes from ExitCodes to be lost.

…for bat files

Mpdreamz · 2019-01-25T15:30:34Z

Thanks for taking a look again @jasontedor

afaict elasticsearch-shard..bat was already covered. Rebased against master and moved elasticsearch-node.bat to the new explicit exit style as well.

jasontedor

LGTM.

* Exit batch files explictly using ERRORLEVEL This makes sure the exit code is preserved when calling the batch files from different contexts other than DOS Fixes #29582 This also fixes specific error codes being masked by an explict exit /b 1 causing the useful exitcodes from ExitCodes to be lost. * fix line breaks for calling cli to match the bash scripts * indent size of bash files is 2, make sure editorconfig does the same for bat files * update indenting to match bash files * update elasticsearch-keystore.bat indenting * Update elasticsearch-node.bat to exit outside of endlocal (cherry picked from commit dfecb25)

* elastic/master: (68 commits) Fix potential IllegalCapacityException in LLRC when selecting nodes (elastic#37821) Mute CcrRepositoryIT#testFollowerMappingIsUpdated Fix S3 Repository ITs When Docker is not Available (elastic#37878) Pass distribution type through to docs tests (elastic#37885) Mute SharedClusterSnapshotRestoreIT#testSnapshotCanceledOnRemovedShard SQL: Fix casting from date to numeric type to use millis (elastic#37869) Migrate o.e.i.r.RecoveryState to Writeable (elastic#37380) ML: removing unnecessary upgrade code (elastic#37879) Relax cluster metadata version check (elastic#37834) Mute TransformIntegrationTests#testSearchTransform Refactored GeoHashGrid unit tests (elastic#37832) Fixes for a few randomized agg tests that fail hasValue() checks Geo: replace intermediate geo objects with libs/geo (elastic#37721) Remove NOREPLACE for /etc/elasticsearch in rpm and deb (elastic#37839) Remove "reinstall" packaging tests (elastic#37851) Add unit tests for ShardStateAction's ShardStartedClusterStateTaskExecutor (elastic#37756) Exit batch files explictly using ERRORLEVEL (elastic#29583) TransportUnfollowAction should increase settings version (elastic#37859) AsyncTwoPhaseIndexerTests race condition fixed (elastic#37830) Do not allow negative variances (elastic#37384) ...

rjernst added the :Delivery/Packaging RPM and deb packaging, tar and zip archives, shell and batch scripts label Apr 18, 2018

colings86 added the >enhancement label Apr 24, 2018

Mpdreamz force-pushed the explicit-exit-on-bat-files branch from 4396f62 to 6a95092 Compare October 30, 2018 13:01

jasontedor reviewed Nov 2, 2018

View reviewed changes

Mpdreamz force-pushed the explicit-exit-on-bat-files branch from 6a95092 to d24b37d Compare December 18, 2018 09:24

jasontedor reviewed Dec 19, 2018

View reviewed changes

jasontedor requested changes Dec 19, 2018

View reviewed changes

jasontedor requested changes Jan 25, 2019

View reviewed changes

Mpdreamz and others added 6 commits January 25, 2019 16:18

fix line breaks for calling cli to match the bash scripts

d3d5a0a

indent size of bash files is 2, make sure editorconfig does the same …

1031409

…for bat files

update indenting to match bash files

03a2733

update elasticsearch-keystore.bat indenting

00ebdee

Update elasticsearch-node.bat to exit outside of endlocal

94d31bc

Mpdreamz force-pushed the explicit-exit-on-bat-files branch from 407f5e5 to 94d31bc Compare January 25, 2019 15:28

jasontedor approved these changes Jan 25, 2019

View reviewed changes

Mpdreamz merged commit dfecb25 into elastic:master Jan 25, 2019

Mpdreamz deleted the explicit-exit-on-bat-files branch January 25, 2019 15:44

danielmitterdorfer added v7.0.0 v6.7.0 labels Jan 31, 2019

colings86 added v7.0.0-beta1 and removed v7.0.0 labels Feb 7, 2019

rjernst mentioned this pull request Oct 30, 2020

elasticsearch-plugin.bat script returns exit code 0 during errors in ES 5.6 #64441

Closed

mark-vieira added the Team:Delivery Meta label for Delivery team label Nov 11, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Exit batch files explictly using ERRORLEVEL #29583

Exit batch files explictly using ERRORLEVEL #29583

Mpdreamz commented Apr 18, 2018

elasticmachine commented Apr 18, 2018

rjernst commented May 20, 2018

Mpdreamz commented May 21, 2018

javanna commented Aug 16, 2018

Mpdreamz commented Oct 30, 2018

jasontedor left a comment

jasontedor Nov 2, 2018

Mpdreamz Dec 18, 2018

jasontedor Nov 2, 2018

jasontedor Dec 19, 2018

jasontedor left a comment

Mpdreamz commented Jan 8, 2019 •

edited

Loading

Mpdreamz commented Jan 24, 2019

jasontedor left a comment

Mpdreamz commented Jan 25, 2019

jasontedor left a comment

Exit batch files explictly using ERRORLEVEL #29583

Exit batch files explictly using ERRORLEVEL #29583

Conversation

Mpdreamz commented Apr 18, 2018

elasticmachine commented Apr 18, 2018

rjernst commented May 20, 2018

Mpdreamz commented May 21, 2018

javanna commented Aug 16, 2018

Mpdreamz commented Oct 30, 2018

jasontedor left a comment

Choose a reason for hiding this comment

jasontedor Nov 2, 2018

Choose a reason for hiding this comment

Mpdreamz Dec 18, 2018

Choose a reason for hiding this comment

jasontedor Nov 2, 2018

Choose a reason for hiding this comment

jasontedor Dec 19, 2018

Choose a reason for hiding this comment

jasontedor left a comment

Choose a reason for hiding this comment

Mpdreamz commented Jan 8, 2019 • edited Loading

Mpdreamz commented Jan 24, 2019

jasontedor left a comment

Choose a reason for hiding this comment

Mpdreamz commented Jan 25, 2019

jasontedor left a comment

Choose a reason for hiding this comment

Mpdreamz commented Jan 8, 2019 •

edited

Loading