test: add tests for calc, dice plugins

[SnoopJ]

Description

This changeset adds tests for the calc, dice plugins, inspired by discussion on #2464.

Checklist

• I have read CONTRIBUTING.md
• I can and do license this contribution under the EFLv2
• No issues are reported by make qa (runs make quality and make test)
• I have tested the functionality of the things this change touches

[dgw]

Is this intended to replace the tests generated by passing expected output to the @plugin.example decorator?

sopel/sopel/modules/calc.py

Lines 14 to 21 in 7b74964

	@plugin.command('c', 'calc')
	@plugin.example('.c 5 + 3', '8')
	@plugin.example('.c 0.9*10', '9')
	@plugin.example('.c 10*0.9', '9')
	@plugin.example('.c 2*(1+2)*3', '18')
	@plugin.example('.c 2**10', '1024')
	@plugin.example('.c 5 // 2', '2')
	@plugin.example('.c 5 / 2', '2.5')

sopel/sopel/modules/dice.py

Lines 170 to 182 in 7b74964

	@plugin.command('roll', 'dice', 'd')
	@plugin.priority("medium")
	@plugin.example(".roll 3d1+1", '3d1+1: (1+1+1)+1 = 4')
	@plugin.example(".roll 3d1v2+1", '3d1v2+1: (1[+1+1])+1 = 2')
	@plugin.example(".roll 2d4", r'2d4: \(\d\+\d\) = \d', re=True)
	@plugin.example(".roll 100d1", r'[^:]*: \(100x1\) = 100', re=True)
	@plugin.example(".roll 1001d1", 'I only have 1000 dice. =(')
	@plugin.example(".roll 1d1 + 1d1", '1d1 + 1d1: (1) + (1) = 2')
	@plugin.example(".roll 1d1+1d1", '1d1+1d1: (1)+(1) = 2')
	@plugin.example(".roll 1d6 # initiative", r'1d6: \(\d\) = \d', re=True)
	@plugin.example(".roll 2d20v1+2 # roll with advantage", user_help=True)
	@plugin.example(".roll 2d10+3", user_help=True)
	@plugin.example(".roll 1d6", user_help=True)

dice has helper functions that could be covered by unit tests, but I'm not entirely sure of the value-add here when the whole point of @example is to allow testing the expected output of commands without needing a separate test file. 🤔

[SnoopJ]

Is this intended to replace the tests generated by passing expected output to the @plugin.example decorator?

I don't think I knew that the decorator tested the observed behavior this way! In that case, this can just be closed, it adds nothing they aren't already covering.

[dgw]

it adds nothing they aren't already covering.

It'd be cool to fill in the gaps, though. calc is at 65% and dice is at 77% coverage according to my local report.

Stuff like empty-argument branches, exception handlers, and other error conditions (including within the aforementioned helper functions) are left out, if you're looking for some test improvements you can make to these plugins. 🙂

(Up to you whether that means adding more examples and making judicious use of the user_help kwarg to @example, or covering the edge/error cases in separate test files. Or replacing the example tests with comprehensive coverage in separate test files… I was just pointing out that the minimal, "normal path" tests you had when opening this PR were redundant!)

[SnoopJ]

Up to you whether that means adding more examples and making judicious use of the user_help kwarg to @example, or covering the edge/error cases in separate test files. Or replacing the example tests with comprehensive coverage in separate test files

I suspect more examples can get the coverage up to somewhere we're happier with. Definitely don't want to replace the examples, they're useful documentation, and splitting between examples and tests seems kind of annoying. I'll have a look-see.