Chore: Not generate boogie translation if not verifying #6067

MikaelMayer · 2025-01-22T19:10:00Z

What was changed?

I ensure the Options.DafnyVerify is set to false if --no-verify is provided, except if --bprint is set

How has this been tested?

A new driver test verifies the new behavior. Without the test, I got it wrong, so I'm confident that the test ensures the behavior is correct.
I don't think there is another way to test that the Boogie translation does not happen when it won't actually verify;

By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.

And not activated by default if `--no-verify` is set. This option emulates the `/dafnyVerify` command in the previous CLI Added tests

keyboardDrummer · 2025-01-23T12:12:00Z

Source/DafnyCore/Options/BoogieOptionBag.cs

@@ -46,6 +46,8 @@ public static class BoogieOptionBag {

  public static readonly Option<bool> NoVerify = new("--no-verify", "Skip verification");

+  public static readonly Option<bool> DoBoogieTranslation = new("--do-boogie-translation", "Requires --no-verify. Does translation to Boogie but Boogie won't verify it.");


It seems strange to have an option that can only be used if another option is also used. Why not have the first option imply the second then? Instead of --do-boogie-translation why not have --no-verify-boogie that tells Dafny to translate to Boogie but not verify it.

That way, whenever the user would type --no-verify --do-boogie-translation they only have to type --no-verify-boogie.

Secondly, I would make this option hidden since it only seems useful for the purpose of debugging the Dafny verification pipeline.

Thirdly, why are you adding this option? Is someone missing this? An alternative would be to let --no-verify --bprint ... cause Dafny to translate to Boogie but not verify that Boogie, and --no-verify to not translate to Boogie at all.

Let's do the simple way. Since we already have --bprint, we can use it as the flag to do boogie translation, period. I like that idea.

Same for --sprint

And --pprint as well. Added

keyboardDrummer · 2025-01-23T15:58:00Z

Source/DafnyCore/Options/BoogieOptionBag.cs

+    DafnyOptions.RegisterLegacyBinding(NoVerify, (options, dotNotVerify) => {
+      var shouldVerify = !dotNotVerify && !options.Get(HiddenNoVerify);
+      options.Verify = shouldVerify; // Boogie won't verify
+      options.DafnyVerify = shouldVerify || options.Get(DeveloperOptionBag.BoogiePrint) != null;


Could you add || options.Get(DeveloperOptionBag.SplitPrint) != null ?

keyboardDrummer · 2025-01-23T15:58:52Z

Source/DafnyDriver/Commands/RunCommand.cs

@@ -49,7 +49,7 @@ static RunCommand() {
      Concat(DafnyCommands.ConsoleOutputOptions).
      Concat(DafnyCommands.ResolverOptions);

-  public static Command Create() {
+  public static Command Create(Func<DafnyOptions, int> continuation = null) {


What is this for?

It's to be able to create a Run command but with a continuation different than the one that launches the regular pipeline, to be able to test the parsing of options only. If you have any other way I could achieve the same result, I'd happily consider it.

keyboardDrummer · 2025-01-23T15:59:55Z

docs/DafnyRef/UserGuide.md

@@ -2294,6 +2294,8 @@ and what information it produces about the verification process.

 * `--no-verify` - turns off verification (for translate, build, run commands)

+* `--do-boogie-translation` - turns on translation to Boogie after resolving or if `--no-verify` is set. Automatically set if `--bprint` is set.


Outdated, please remove

keyboardDrummer · 2025-01-23T17:10:51Z

Source/DafnyDriver.Test/OptionsTest.cs

+  [Fact]
+  public async Task RunFlagsOverride() {
+    await TestCliRunArgs([], options => {
+      Assert.True(options.DafnyVerify);


I'm not a fan of tests for values in options., since these are implementation details. In the future we could do a refactoring that removes options.DafnyVerify, and then what would we do with this test?

Implementation details can still be tested by unit tests, and this is the meaning of that.
If we remove options.DafnyVerify, we would simply remove that test (and add new tests to test the new behavior).

But why test like this? You could also test without looking at internals. For example, by using the --progress Symbol flag, you will see different results when using --no-verify and when not using it, and of course you can check that --no-verify --bprint still creates a file.

I did not know about --progress Symbol until your message, that looks like it would make a nice integration test. I can envision creating a test based on that if you prefer.
But first, what makes you uncomfortable with unit tests like this?

But first, what makes you uncomfortable with unit tests like this?

Concretely, I plan on removing DafnyOptions.DafnyVerify and this test will make that harder. More generally, for tests against implementation it's hard to say how long it takes they need to be replaced. It'd rather not create work further down the line.

--progress Symbol is not producing any difference between the two command lines:

> make test-dafny name="rust/datatypes.dfy" action="run -t:rs --progress Symbol --no-verify" > make test-dafny name="rust/datatypes.dfy" action="run -t:rs --progress Symbol"

The two commands output exactly the same thing.
I see that there is a barely used option options.Get(CommonOptionBag.LogLevelOption); that I could configure so that if it's set to verbose, it will emit something when entering translation. Would that work for you?

Right, --progress is not supported by the commands that have not been ported to the new front-end yet, translate/build/run, so it's ignored.

If options.Get(CommonOptionBag.LogLevelOption) works that's great too.

Chore: Support for --do-boogie-translation

3dbf68f

And not activated by default if `--no-verify` is set. This option emulates the `/dafnyVerify` command in the previous CLI Added tests

MikaelMayer requested a review from keyboardDrummer January 22, 2025 19:10

keyboardDrummer reviewed Jan 23, 2025

View reviewed changes

review comments

865aa96

MikaelMayer requested a review from keyboardDrummer January 23, 2025 15:38

MikaelMayer changed the title ~~Chore: Support for --do-boogie-translation~~ Chore: Not generate boogie translation if not verifying Jan 23, 2025

keyboardDrummer reviewed Jan 23, 2025

View reviewed changes

MikaelMayer added 2 commits January 23, 2025 10:48

Fixed the CI

2e5d2c8

Merge branch 'master' into chore-do-boogie-translation

61a457f

keyboardDrummer reviewed Jan 23, 2025

View reviewed changes

MikaelMayer and others added 8 commits January 24, 2025 13:32

Fixed CI + enhanced error reporting

54e6ec2

Merge branch 'master' into chore-do-boogie-translation

9cf72a0

Added integration test + Reverted unit testing

4f2b8e1

Merge branch 'master' into chore-do-boogie-translation

29394cf

Fixed CI

6512bc3

Fixed tests

4d5a51b

Fixed the build

025e739

Replaced spaces by tabs

9946191

MikaelMayer enabled auto-merge (squash) February 3, 2025 20:07

keyboardDrummer approved these changes Feb 4, 2025

View reviewed changes

Merge branch 'master' into chore-do-boogie-translation

68b9ab0

MikaelMayer merged commit 4d1a82b into master Feb 4, 2025
22 checks passed

MikaelMayer deleted the chore-do-boogie-translation branch February 4, 2025 14:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Chore: Not generate boogie translation if not verifying #6067

Chore: Not generate boogie translation if not verifying #6067

MikaelMayer commented Jan 22, 2025 •

edited

Loading

keyboardDrummer Jan 23, 2025 •

edited

Loading

MikaelMayer Jan 23, 2025

keyboardDrummer Jan 23, 2025

MikaelMayer Jan 23, 2025

keyboardDrummer Jan 23, 2025 •

edited

Loading

keyboardDrummer Jan 23, 2025

MikaelMayer Jan 23, 2025

keyboardDrummer Jan 23, 2025 •

edited

Loading

keyboardDrummer Jan 23, 2025

MikaelMayer Jan 23, 2025 •

edited

Loading

keyboardDrummer Jan 24, 2025

MikaelMayer Jan 24, 2025

keyboardDrummer Jan 27, 2025

MikaelMayer Jan 30, 2025

keyboardDrummer Jan 30, 2025 •

edited

Loading

		@@ -46,6 +46,8 @@ public static class BoogieOptionBag {

		public static readonly Option<bool> NoVerify = new("--no-verify", "Skip verification");

		public static readonly Option<bool> DoBoogieTranslation = new("--do-boogie-translation", "Requires --no-verify. Does translation to Boogie but Boogie won't verify it.");

		@@ -2294,6 +2294,8 @@ and what information it produces about the verification process.

		* `--no-verify` - turns off verification (for translate, build, run commands)

		* `--do-boogie-translation` - turns on translation to Boogie after resolving or if `--no-verify` is set. Automatically set if `--bprint` is set.

Chore: Not generate boogie translation if not verifying #6067

Chore: Not generate boogie translation if not verifying #6067

Conversation

MikaelMayer commented Jan 22, 2025 • edited Loading

What was changed?

How has this been tested?

keyboardDrummer Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

keyboardDrummer Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

keyboardDrummer Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MikaelMayer Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

keyboardDrummer Jan 30, 2025 • edited Loading

Choose a reason for hiding this comment

MikaelMayer commented Jan 22, 2025 •

edited

Loading

keyboardDrummer Jan 23, 2025 •

edited

Loading

keyboardDrummer Jan 23, 2025 •

edited

Loading

keyboardDrummer Jan 23, 2025 •

edited

Loading

MikaelMayer Jan 23, 2025 •

edited

Loading

keyboardDrummer Jan 30, 2025 •

edited

Loading