KeywordBear.py: Output appropriate message #1271

Techievena · 2017-01-07T02:33:56Z

Output appropriate message if the language given in input is not valid/not supported for KeywordBear

gitmate-bot · 2017-01-07T02:34:09Z

Thanks for your contribution!

Reviewing pull requests take really a lot of time and we're all volunteers. Please make sure you go through the following check list and complete them all before pinging someone for a review.

I have rebased properly. Please see this for a tutorial.
I have gone through the commit guidelines and I've followed them:
I have followed the guidelines for the commit shortlog.
I have followed the guidelines for the commit body.
I have included the issue URL.
I have used the Fixes keyword if the commit fixes a real bug and the Closes keyword if it adds a feature/enhancement. See more here.
I have run all the tests and they all pass. That includes that all CI (below) is green - if GitMate issues appear you will have to amend your commits, pushing new commits on top is not sufficient!

As you learn things over your Pull Request please help others on the chat and on PRs to get their stuff right as well!

gitmate-bot · 2017-01-07T02:34:43Z

bears/general/KeywordBear.py

+        for result in annotation_bear_results:
+            yield from result.contents.get('comments', [])
+    except Exception:
+        raise TypeError('Given Language in the input is not supported by KeywordBear')


Line is longer than allowed. (86 > 79)

LineLengthBear, severity NORMAL, section linelength.

gitmate-bot · 2017-01-07T02:34:44Z

bears/general/KeywordBear.py

+            yield from result.contents.get('comments', [])
+    except Exception:
+        raise TypeError('Given Language in the input is not supported by KeywordBear')
+


Line contains following spacing inconsistencies:

Trailing whitespaces.

SpaceConsistencyBear, severity NORMAL, section python.

The issue can be fixed by applying the following patch:

--- a/bears/general/KeywordBear.py +++ b/bears/general/KeywordBear.py @@ -23,7 +23,7 @@ yield from result.contents.get('comments', []) except Exception: raise TypeError('Given Language in the input is not supported by KeywordBear') - + def generate_diff(comments, file, filename,

gitmate-bot · 2017-01-07T02:34:44Z

bears/general/KeywordBear.py

+            yield from result.contents.get('comments', [])
+    except Exception:
+        raise TypeError('Given Language in the input is not supported by KeywordBear')
+


 def generate_diff(comments, file, filename,


E303 too many blank lines (3)'

PycodestyleBear (E303), severity NORMAL, section autopep8.

gitmate-bot · 2017-01-07T02:34:45Z

bears/general/KeywordBear.py

+            yield from result.contents.get('comments', [])
+    except Exception:
+        raise TypeError('Given Language in the input is not supported by KeywordBear')
+


W293 blank line contains whitespace'

PycodestyleBear (W293), severity NORMAL, section autopep8.

gitmate-bot · 2017-01-07T02:34:45Z

bears/general/KeywordBear.py

+        for result in annotation_bear_results:
+            yield from result.contents.get('comments', [])
+    except Exception:
+        raise TypeError('Given Language in the input is not supported by KeywordBear')


E501 line too long (86 > 79 characters)'

PycodestyleBear (E501), severity NORMAL, section autopep8.

gitmate-bot · 2017-01-07T02:34:46Z

Comment on 5c94a92.

Body of HEAD commit contains too long lines. Commit body lines should not exceed 72 characters.

GitCommitBear, severity NORMAL, section commit.

gitmate-bot · 2017-01-07T02:34:46Z

bears/general/KeywordBear.py

+        for result in annotation_bear_results:
+            yield from result.contents.get('comments', [])
+    except Exception:
+        raise TypeError('Given Language in the input is not supported by KeywordBear')


The code does not comply to PEP8.

PEP8Bear, severity NORMAL, section autopep8.

The issue can be fixed by applying the following patch:

--- a/bears/general/KeywordBear.py +++ b/bears/general/KeywordBear.py @@ -22,8 +22,8 @@ for result in annotation_bear_results: yield from result.contents.get('comments', []) except Exception: - raise TypeError('Given Language in the input is not supported by KeywordBear') - + raise TypeError( + 'Given Language in the input is not supported by KeywordBear') def generate_diff(comments, file, filename,

gitmate-bot · 2017-01-07T02:40:06Z

bears/general/KeywordBear.py

+            yield from result.contents.get('comments', [])
+    except Exception:
+        raise TypeError('Given Language in the input is not supported by KeywordBear')
+


Line contains following spacing inconsistencies:

Trailing whitespaces.

SpaceConsistencyBear, severity NORMAL, section python.

The issue can be fixed by applying the following patch:

--- a/bears/general/KeywordBear.py +++ b/bears/general/KeywordBear.py @@ -23,7 +23,7 @@ yield from result.contents.get('comments', []) except Exception: raise TypeError('Given Language in the input is not supported by KeywordBear') - + def generate_diff(comments, file, filename, line, line_number, pos):

gitmate-bot · 2017-01-07T02:40:06Z

bears/general/KeywordBear.py

+        for result in annotation_bear_results:
+            yield from result.contents.get('comments', [])
+    except Exception:
+        raise TypeError('Given Language in the input is not supported by KeywordBear')


Line is longer than allowed. (86 > 79)

LineLengthBear, severity NORMAL, section linelength.

gitmate-bot · 2017-01-07T02:40:07Z

Comment on 6c77db6.

Body of HEAD commit contains too long lines. Commit body lines should not exceed 72 characters.

GitCommitBear, severity NORMAL, section commit.

gitmate-bot · 2017-01-07T02:40:08Z

bears/general/KeywordBear.py

+            yield from result.contents.get('comments', [])
+    except Exception:
+        raise TypeError('Given Language in the input is not supported by KeywordBear')
+


W293 blank line contains whitespace'

PycodestyleBear (W293), severity NORMAL, section autopep8.

gitmate-bot · 2017-01-07T02:40:08Z

bears/general/KeywordBear.py

+        for result in annotation_bear_results:
+            yield from result.contents.get('comments', [])
+    except Exception:
+        raise TypeError('Given Language in the input is not supported by KeywordBear')


E501 line too long (86 > 79 characters)'

PycodestyleBear (E501), severity NORMAL, section autopep8.

gitmate-bot · 2017-01-07T02:40:09Z

bears/general/KeywordBear.py

+        for result in annotation_bear_results:
+            yield from result.contents.get('comments', [])
+    except Exception:
+        raise TypeError('Given Language in the input is not supported by KeywordBear')


The code does not comply to PEP8.

PEP8Bear, severity NORMAL, section autopep8.

The issue can be fixed by applying the following patch:

--- a/bears/general/KeywordBear.py +++ b/bears/general/KeywordBear.py @@ -22,8 +22,9 @@ for result in annotation_bear_results: yield from result.contents.get('comments', []) except Exception: - raise TypeError('Given Language in the input is not supported by KeywordBear') - + raise TypeError( + 'Given Language in the input is not supported by KeywordBear') + def generate_diff(comments, file, filename, line, line_number, pos):

gitmate-bot · 2017-01-07T02:44:43Z

Comment on 9b94b80.

Body of HEAD commit contains too long lines. Commit body lines should not exceed 72 characters.

GitCommitBear, severity NORMAL, section commit.

Shade5 · 2017-01-07T03:39:14Z

KeywordBear.py is not fully covered by the tests. You'll have to add tests for 100% coverage

Shade5 · 2017-01-07T04:41:31Z

Run py.test --cov to check coverage. You have to get 100% coverage for KeywordBear.py

aptrishu · 2017-01-07T14:10:46Z

bears/general/KeywordBear.py

+    try:
+        for result in annotation_bear_results:
+            yield from result.contents.get('comments', [])
+    except AttributeError:


check January 7, 2017 7:17 PM

@aptrishu I think it's a lot simpler to use github as the main review UI, just copying the text from gitter makes it way easier for other reviewers to see what's going on here

Techievena · 2017-01-10T07:36:38Z

@Shade5 Need help in writing test case

Shade5 · 2017-01-10T07:56:04Z

Does py.test work fine without your changes?
Show me the output of py.test -k KeywordBearTest --cov

Techievena · 2017-01-10T07:58:54Z

Here is it @Shade5

Shade5 · 2017-01-10T08:00:43Z

So you need to write two tests. One that satisties the if at 23 and another that does not. Add those tests to KeywordBearTest.py

Techievena · 2017-01-10T08:03:43Z

Yes I am trying to cover the log statements using assertLogs but they are failing. Can you have a look on test case I have wrriten

Shade5 · 2017-01-10T08:06:43Z

How are you calling _get_comments() in your test?

Techievena · 2017-01-10T08:07:56Z

I think execute_bear is calling them. I mean it is executing KeywordBear so _get_comments( ) automatically gets called.

Shade5 · 2017-01-10T08:18:38Z

Any errors with py.test -k KeywordBearTest --cov ?

Techievena · 2017-01-10T08:22:24Z

I've imported logging in both Keyword.py and KeywordBearTest.py and py.test -k KeywordBearTest --cov is returning the same as before

Techievena · 2017-01-10T08:23:10Z

adtac · 2017-01-11T10:38:57Z

tests/general/KeywordBearTest.py

+            'AnnotationBear': [
+                annotation_bear_result_type(
+                  'coalang specification for anything not found.'
+                  )


We end the brackets/parantheses in the same line as the last element. See line 207 of this file.

adtac · 2017-01-11T10:40:21Z

tests/general/KeywordBearTest.py

+
+        text = ['# todo 123']
+
+        with execute_bear(self.uut, 'F', text,


Please use named arguments - they're easier to read. Every other test uses them and consistent is better :)

See line 211 of this file.

adtac · 2017-01-11T10:42:56Z

tests/general/KeywordBearTest.py

+                          dependency_results=dep_results) as result:
+            self.assertEqual(result[0].diffs, {})
+            self.assertEqual(result[0].affected_code[0].start.line, 1)
+            self.assertEqual(len(result), 1)


this should probably be the first assert :3

And there aren't any checks to make sure the message is logged? I mean, that's what the whole PR is about.

Techievena · 2017-01-11T12:22:46Z

@adtac Done with the changes. Is it mergeable now? 😃

sils · 2017-01-11T13:02:16Z

bears/general/KeywordBear.py

-        yield from result.contents.get('comments', [])
+        if isinstance(result.contents, str):
+            logging.error(result.contents)
+            yield []


why do you yield an empty list? I'd just remove it.

what if I'm expecting a list? not yielding a list might trigger an exception

As it was yeilding an empty list when comments key was not found in request.contents I thought I had to do the same in case when this execption arises.
Fine I'll remove it 👍

uhm yield is not a return @adtac

ah didn't realize the original was a yield from, not a yield

Output appropriate message if the language given in input is not valid/not supported for KeywordBear Fixes coala#1256

sils · 2017-01-11T15:15:20Z

ack 75ae1c9

sils · 2017-01-11T15:15:25Z

@rultor merge

rultor · 2017-01-11T15:15:49Z

@rultor merge

@sils OK, I'll try to merge now. You can check the progress of the merge here

rultor · 2017-01-11T15:17:25Z

@rultor merge

@sils Done! FYI, the full log is here (took me 1min)

gitmate-bot added process/pending review size/XS labels Jan 7, 2017

gitmate-bot reviewed Jan 7, 2017

View reviewed changes

Techievena force-pushed the development branch from 5c94a92 to 6c77db6 Compare January 7, 2017 02:39

gitmate-bot reviewed Jan 7, 2017

View reviewed changes

Techievena force-pushed the development branch from 6c77db6 to 9b94b80 Compare January 7, 2017 02:43

Techievena force-pushed the development branch from 9b94b80 to d135f43 Compare January 7, 2017 02:46

Techievena force-pushed the development branch from d135f43 to 5b0ab35 Compare January 7, 2017 04:31

coala-bot added process/wip and removed process/pending review labels Jan 7, 2017

aptrishu previously requested changes Jan 7, 2017

View reviewed changes

Techievena force-pushed the development branch from 5b0ab35 to 44d0cf8 Compare January 8, 2017 01:47

gitmate-bot added process/pending review and removed process/wip size/XS labels Jan 8, 2017

Techievena force-pushed the development branch from 29611c8 to e12b1a7 Compare January 10, 2017 05:59

Techievena force-pushed the development branch from e12b1a7 to 1ecdf12 Compare January 10, 2017 07:45

Techievena force-pushed the development branch from 1ecdf12 to ea92914 Compare January 11, 2017 06:32

gitmate-bot added size/L and removed size/S labels Jan 11, 2017

Techievena force-pushed the development branch from ea92914 to cda2c86 Compare January 11, 2017 08:19

gitmate-bot added size/S and removed size/L labels Jan 11, 2017

Techievena force-pushed the development branch from cda2c86 to 2308997 Compare January 11, 2017 10:00

adtac reviewed Jan 11, 2017

View reviewed changes

Techievena force-pushed the development branch from 2308997 to f548edd Compare January 11, 2017 12:19

sils reviewed Jan 11, 2017

View reviewed changes

KeywordBear.py: Output appropriate message

75ae1c9

Output appropriate message if the language given in input is not valid/not supported for KeywordBear Fixes coala#1256

Techievena force-pushed the development branch from f548edd to 75ae1c9 Compare January 11, 2017 13:27

rultor merged commit 75ae1c9 into coala:master Jan 11, 2017

KeywordBear.py: Output appropriate message #1271

KeywordBear.py: Output appropriate message #1271

Conversation

Techievena commented Jan 7, 2017

gitmate-bot commented Jan 7, 2017

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

gitmate-bot commented Jan 7, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gitmate-bot commented Jan 7, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gitmate-bot commented Jan 7, 2017

Shade5 commented Jan 7, 2017

Shade5 commented Jan 7, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Techievena commented Jan 10, 2017

Shade5 commented Jan 10, 2017

Techievena commented Jan 10, 2017

Shade5 commented Jan 10, 2017

Techievena commented Jan 10, 2017

Shade5 commented Jan 10, 2017

Techievena commented Jan 10, 2017 • edited Loading

Shade5 commented Jan 10, 2017

Techievena commented Jan 10, 2017

Techievena commented Jan 10, 2017

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

Techievena commented Jan 11, 2017

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

sils commented Jan 11, 2017

sils commented Jan 11, 2017

rultor commented Jan 11, 2017

rultor commented Jan 11, 2017

Shade5 commented Jan 7, 2017 •

edited

Loading

Techievena commented Jan 10, 2017 •

edited

Loading