Summary

Added unit tests for rbt alias command

Review Request #10989 — Created April 5, 2020 and submitted Aug. 17, 2020, 5:49 p.m.

Information

Owner

kpatenio

Repository

RBTools

Branch

release-2.0.x

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

Added unit tests for rbt alias command

Testing Done

Test cases run on python 2.7.17 and 3.7.6.

- Test case validating output for '--list' option with defined alias
- Test case validating output for '--list' option  with undefined alias
- Test case validating '--list' option in debug mode
- Test case validating output for '--dry-run' option with defined alias
- Test case validating output for '--dry-run' option with undefined alias
- Test case validating  '--dry-run' option with missing arg
- Test case validating '--dry-run' option in debug mode

Commits

Summary	ID	Author
Added unit tests for rbt alias command Testing Done: Test cases run on python 2.7.17 and 3.7.6. - Test case validating output for '--list' option with defined alias - Test case validating output for '--list' option with undefined alias - Test case validating '--list' option in debug mode - Test case validating output for '--dry-run' option with defined alias - Test case validating output for '--dry-run' option with undefined alias - Test case validating '--dry-run' option with missing arg - Test case validating '--dry-run' option in debug mode	3ee90965956ba576879adf9f590a423e6ecc8f45	kpatenio

Issues

Description	From	Last Updated
For mentors: flake8 does not seem to like the fact that I have repeated dictionary keys in a couple test …	kpatenio	April 10, 2020, 6:34 a.m.
Since this can get a bit weird-looking, the pattern we prefer is: config = { 'ALIASES': { ... } } …	chipx86	April 10, 2020, 6:34 a.m.
F601 dictionary key u'alias1' repeated with different values	reviewbot	April 10, 2020, 6:35 a.m.
F601 dictionary key u'alias1' repeated with different values	reviewbot	April 10, 2020, 6:35 a.m.
F601 dictionary key u'alias1' repeated with different values	reviewbot	April 10, 2020, 6:35 a.m.
F601 dictionary key u'alias1' repeated with different values	reviewbot	April 10, 2020, 6:35 a.m.
Mentioned this in another review request, but you'll want to use += for consistency and performance (this isn't performance-critical code, …	chipx86	April 10, 2020, 6:34 a.m.

flake8 failed.

JSHint passed.

flake8

rbtools/commands/tests/test_alias.py (Diff revision 1)
The issue has been dropped. Show all issues
```
F601 dictionary key u'alias1' repeated with different values
```
rbtools/commands/tests/test_alias.py (Diff revision 1)
The issue has been dropped. Show all issues
```
F601 dictionary key u'alias1' repeated with different values
```
rbtools/commands/tests/test_alias.py (Diff revision 1)
The issue has been dropped. Show all issues
```
F601 dictionary key u'alias1' repeated with different values
```
rbtools/commands/tests/test_alias.py (Diff revision 1)
The issue has been dropped. Show all issues
```
F601 dictionary key u'alias1' repeated with different values
```

The issue has been dropped. Show all issues

For mentors: flake8 does not seem to like the fact that I have repeated dictionary keys in a couple test cases that I made.

Would you recommend I ignore these? Or should I omit this type of test case from my unit tests?

chipx86 April 9, 2020, 1:07 a.m.

Repeated dictionary keys will get filtered out, so they are a problem. Only one key will win, and which one will depend on the version of Python you're working with. You're probably not getting the testing you're expecting with that.

kpatenio April 10, 2020, 6:34 a.m.

Ah that's interesting. Considering that the key chosen depends on the Python version, I feel inclined to remove these tests for now.

rbtools/commands/tests/test_alias.py (Diff revision 1)

The issue has been resolved. Show all issues

Since this can get a bit weird-looking, the pattern we prefer is:

config = {
    'ALIASES': {
        ...
    }
}

with self.reviewboardrc(config):
    ...


Keeps it a lot more manageable.

rbtools/commands/tests/test_alias.py (Diff revision 1)

The issue has been resolved. Show all issues

Mentioned this in another review request, but you'll want to use += for consistency and performance (this isn't performance-critical code, but still worth doing).

Commits:

	Summary	ID	Author
	Added unit tests for rbt alias command Testing Done: Test cases run on python 2.7.17 and 3.7.6. - Test case validating output for '--list' option with defined alias - Test case validating output for '--list' option with undefined alias - Test case validating output for '--list' option with duplicated alias - Test case validating '--list' option in debug mode - Test case validating output for '--dry-run' option with defined alias - Test case validating output for '--dry-run' option with undefined alias - Test case validating '--dry-run' option with missing arg - Test case validating output for '--dry-run' option with duplicated alias - Test case validating '--dry-run' option in debug mode	7535c8bc4abc73200423821a35e8a00b08f97973	kpatenio
	Added unit tests for rbt alias command Testing Done: Test cases run on python 2.7.17 and 3.7.6. - Test case validating output for '--list' option with defined alias - Test case validating output for '--list' option with undefined alias - Test case validating '--list' option in debug mode - Test case validating output for '--dry-run' option with defined alias - Test case validating output for '--dry-run' option with undefined alias - Test case validating '--dry-run' option with missing arg - Test case validating '--dry-run' option in debug mode	3ee90965956ba576879adf9f590a423e6ecc8f45	kpatenio

Diff:

Revision 2 (+268)

Show changes

rbtools/commands/tests/test_alias.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Updated description

Testing Done:

		Test cases run on python 2.7.17 and 3.7.6.

		`- Test case validating output for '--list' option with defined alias`
		- Test case validating output for '--list' option with undefined alias
-		- Test case validating output for '--list' option with duplicated alias
		- Test case validating '--list' option in debug mode
		- Test case validating output for '--dry-run' option with defined alias
		- Test case validating output for '--dry-run' option with undefined alias
		- Test case validating '--dry-run' option with missing arg
-		- Test case validating output for '--dry-run' option with duplicated alias
		- Test case validating '--dry-run' option in debug mode

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-2.0.x (9cf668a)