Refactor `System.exit` into return codes or exceptions #27

cyrille-artho · 2019-01-30T14:39:13Z

For being able to use a unit-test framework on some system tests, failing configurations have to avoid exiting the VM. Therefore, it is essential that the use of System.exit is minimized.
This requires refactoring a lot of existing code:

main cannot have a return value, so a different function (e.g., run) should provide the same functionality with a return value instead of exit code. main continues to provide an exit code for system tests and production usage, calling run internally.
Any usage of System.exit should be rewritten such that, at the top level, run returns the status as an exit code, and only main actually exits.

As of now, there are 13 instances of System.exit in the code base.

The text was updated successfully, but these errors were encountered:

modified: src/main/scala/modbat/mbt/Dotify.scala, src/main/scala/modbat/mbt/Main.scala, src/main/scala/modbat/mbt/Modbat.scala

…o return. modified: config/src/main/scala/modbat/config/ConfigMgr.scala, src/main/scala/modbat/mbt/Main.scala

cyrille-artho · 2019-01-31T09:16:10Z

Refactored some uses in the commits shown above. 8 instances left.

modified: src/main/scala/modbat/mbt/Dotify.scala

cyrille-artho · 2019-03-04T09:08:18Z

For cases with deeply nested method calls, exceptions would be a better way of propagating error codes (as that would not require inserting "return" statements everywhere).

cyrille-artho · 2019-03-04T09:09:31Z

I'll review the earlier changes w.r.t. that and convert return statements to exceptions if appropriate, and will then move on to the forked repo.

cyrille-artho · 2019-03-11T10:16:44Z

Something was not done so well (my mistake...); check issue #45.

…so in Main) modified: src/main/scala/modbat/mbt/Dotify.scala modified: src/main/scala/modbat/mbt/Main.scala

) modified: src/main/scala/modbat/mbt/Dotify.scala modified: src/main/scala/modbat/mbt/Main.scala

AlexandreFournel · 2019-05-14T13:14:25Z

Existing changes to change again (to use exceptions):
14c1fe8

ConfigMgr.scala: main
ConfigMgr.scala: parseArgs incl. return type
Main.main: use of parseArgs

03899e8
Already modified.

24a882f

Remaining uses of System.exit

* Issue #27: change return code in Dotify to exception (also in Main) modified: src/main/scala/modbat/mbt/Dotify.scala modified: src/main/scala/modbat/mbt/Main.scala * Line 45, I replaced return 1 by throw e in Main.scala

* Issue #27: change return code in Dotify to exception (also in Main) modified: src/main/scala/modbat/mbt/Dotify.scala modified: src/main/scala/modbat/mbt/Main.scala * Line 45, I replaced return 1 by throw e in Main.scala * in file MBT.scala, severals System.exit(1) replaced by throw(error)

modified: src/main/scala/modbat/mbt/Main.scala: Updated comment.

new file: src/main/java/modbat/mbt/NoTransitionException.java modified: src/main/scala/modbat/mbt/MBT.scala

cyrille-artho · 2019-05-15T12:56:08Z

Return codes left: ConfigMgr.scala (both 0 and 1): replace "return 1" with exception, remove "return 0", and make "run" have no return parameters; Main.scala: replace "return 1" with exceptions.

cyrille-artho · 2019-05-15T12:56:48Z

System.exit: a couple left; try:
find . -name '*.scala' | xargs grep 'System.exit'

* Issue #27: change return code in Dotify to exception (also in Main) * Line 45, I replaced return 1 by throw e in Main.scala * in file MBT.scala, several System.exit(1) replaced by throw(error) * in file MBT.scala, System.exit changed by throw new file: src/main/java/modbat/mbt/NoTransitionException.java modified: src/main/scala/modbat/mbt/MBT.scala modified: src/main/scala/modbat/mbt/Dotify.scala modified: src/main/scala/modbat/mbt/Main.scala

* Issue #27: change return code in Dotify to exception (also in Main) modified: src/main/scala/modbat/mbt/Dotify.scala modified: src/main/scala/modbat/mbt/Main.scala * Line 45, I replaced return 1 by throw e in Main.scala * in file MBT.scala, severals System.exit(1) replaced by throw(error) * in file MBT.scala, System.exit changed by throw * Issue #27: change exit to exception. new file: src/main/java/modbat/mbt/NoTransitionException.java modified: src/main/scala/modbat/mbt/MBT.scala * Remove return 1 replaced by throw exception.

…ala (#52) * Issue #27: change return code in Dotify to exception (also in Main) modified: src/main/scala/modbat/mbt/Dotify.scala modified: src/main/scala/modbat/mbt/Main.scala * in file MBT.scala, several System.exit(1) replaced by throw(error) * in file MBT.scala, System.exit changed by throw * Issue #27: change exit to exception. new file: src/main/java/modbat/mbt/NoTransitionException.java modified: src/main/scala/modbat/mbt/MBT.scala * New changes - in MBT.scala, but also in ModbatTestHarness.scala * New changes - no return 1 in ConfigMgr.scala, but now there are exceptions * New changes : add a try catch in ConfigMgr

cyrille-artho · 2019-05-21T07:29:05Z

Remaining open points:

Modbat.explore should not have return code
Main.run should not have return code
Main.main should not not use return code of run (perhaps pending in a current PR?)

…48) * Issue #27: change return code in Dotify to exception (also in Main) * Line 45, I replaced return 1 by throw e in Main.scala * in file MBT.scala, several System.exit(1) replaced by throw(error) * in file MBT.scala, System.exit changed by throw * Issue #27: change exit to exception. * New changes : add a try catch in ConfigMgr * new changes, I don't really know if it's correct because the number of wrong tests has increased (due to the number with . which are not understood as number by ma MacOS * Issue #27: remove return code in Main.run. * Issue #27: remove return code in explore.

cyrille-artho added a commit that referenced this issue Jan 31, 2019

Refactoring (issue #27): provide Main.run, refactor System.exit usage.

14c1fe8

modified: src/main/scala/modbat/mbt/Dotify.scala, src/main/scala/modbat/mbt/Main.scala, src/main/scala/modbat/mbt/Modbat.scala

cyrille-artho added a commit that referenced this issue Jan 31, 2019

Issue #27: Add ConfigMgr.run; Refactored some uses of System.exit int…

24a882f

…o return. modified: config/src/main/scala/modbat/config/ConfigMgr.scala, src/main/scala/modbat/mbt/Main.scala

cyrille-artho mentioned this issue Jan 31, 2019

Migrate the simplest system test to scalatest (as a unit test) #26

Closed

cyrille-artho added a commit that referenced this issue Jan 31, 2019

Issue #27: Refactor c'tor to avoid System.exit.

03899e8

modified: src/main/scala/modbat/mbt/Dotify.scala

cyrille-artho mentioned this issue Feb 14, 2019

Avoid registering shutdown hook if it already exists #31

Closed

henrikglass mentioned this issue Feb 27, 2019

Refactor System.exit into return codes henrikglass/modbat#1

Open

9 tasks

cyrille-artho changed the title ~~Refactor System.exit into return codes~~ Refactor System.exit into return codes or exceptions Mar 4, 2019

cyrille-artho mentioned this issue Mar 11, 2019

"scala build/modbat.jar -h" fails with NPE #45

Closed

AlexandreFournel pushed a commit to AlexandreFournel/modbat that referenced this issue May 13, 2019

Issue cyrille-artho#27: change return code in Dotify to exception (al…

ce91d46

…so in Main) modified: src/main/scala/modbat/mbt/Dotify.scala modified: src/main/scala/modbat/mbt/Main.scala

cyrille-artho pushed a commit that referenced this issue May 13, 2019

Issue #27: change return code in Dotify to exception (also in Main) (#46

7e57d85

) modified: src/main/scala/modbat/mbt/Dotify.scala modified: src/main/scala/modbat/mbt/Main.scala

cyrille-artho added a commit that referenced this issue May 15, 2019

Issue #27: comment.

8c0f4f1

modified: src/main/scala/modbat/mbt/Main.scala: Updated comment.

AlexandreFournel pushed a commit to AlexandreFournel/modbat that referenced this issue May 15, 2019

Issue cyrille-artho#27: change exit to exception.

e2d5593

new file: src/main/java/modbat/mbt/NoTransitionException.java modified: src/main/scala/modbat/mbt/MBT.scala

AlexandreFournel pushed a commit to AlexandreFournel/modbat that referenced this issue May 21, 2019

Issue cyrille-artho#27: remove return code in Main.run.

f6bd321

AlexandreFournel pushed a commit to AlexandreFournel/modbat that referenced this issue May 21, 2019

Issue cyrille-artho#27: remove return code in explore.

01b8287

cyrille-artho closed this as completed May 21, 2019

cyrille-artho mentioned this issue May 22, 2019

Unit tests should use environment variable for class path #38

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor `System.exit` into return codes or exceptions #27

Refactor `System.exit` into return codes or exceptions #27

cyrille-artho commented Jan 30, 2019 •

edited

Loading

cyrille-artho commented Jan 31, 2019

cyrille-artho commented Mar 4, 2019

cyrille-artho commented Mar 4, 2019

cyrille-artho commented Mar 11, 2019

AlexandreFournel commented May 14, 2019 •

edited

Loading

cyrille-artho commented May 15, 2019

cyrille-artho commented May 15, 2019 •

edited

Loading

cyrille-artho commented May 21, 2019

Refactor System.exit into return codes or exceptions #27

Refactor System.exit into return codes or exceptions #27

Comments

cyrille-artho commented Jan 30, 2019 • edited Loading

cyrille-artho commented Jan 31, 2019

cyrille-artho commented Mar 4, 2019

cyrille-artho commented Mar 4, 2019

cyrille-artho commented Mar 11, 2019

AlexandreFournel commented May 14, 2019 • edited Loading

cyrille-artho commented May 15, 2019

cyrille-artho commented May 15, 2019 • edited Loading

cyrille-artho commented May 21, 2019

Refactor `System.exit` into return codes or exceptions #27

Refactor `System.exit` into return codes or exceptions #27

cyrille-artho commented Jan 30, 2019 •

edited

Loading

AlexandreFournel commented May 14, 2019 •

edited

Loading

cyrille-artho commented May 15, 2019 •

edited

Loading