Auto comment on issues found in pull request by mzfr · Pull Request #34 · xbmc/addon-check

mzfr · 2018-02-11T15:14:22Z

It fixes issue #27

This will help in informing contributors about the problems in their add-ons.

I have tested it locally but haven't tested it on Travis-CI.

check_repo.py

-    elif error_counter["warnings"] > 0:
-        # If we only found warnings, don't mark the build as broken
-        colorPrint("We found %s problems and %s warnings, please check the logfile." % (
-            error_counter["problems"], error_counter["warnings"]), "35")


git_comments.py

+    # These are default Travis variables identifying a pull request
+    # https://docs.travis-ci.com/user/environment-variables/#Default-Environment-Variables
+    repo = os.environ["TRAVIS_REPO_SLUG"]
+    pr = os.environ["TRAVIS_PULL_REQUEST"]


check_addon.py


 def _logProblem(error_counter, problem_string):
    colorPrint("PROBLEM: %s" % problem_string, "31")
+    comments.append("PROBLEM: %s" % problem_string)  


razzeee · 2018-02-11T19:29:41Z

Thank you for this, looks very promissing. I will try to run it on my github branch via travis as soon as you are able to fix the minors :)

mzfr · 2018-02-12T16:27:15Z

I've fixed the issues and also tested on travis

check_repo.py

            addon_path = os.path.join(repo_path, addon_folder)
            error_counter = check_addon.start(error_counter, addon_path, config)
+
+    if check_addon.comments:


mzfr · 2018-02-15T13:06:25Z

Made few changes suggested by @MartijnKaijser and @razzeee

mzfr · 2018-02-16T15:03:48Z

@razzeee I have added option for .test-config.json.

I have tested it on a config file similar to this:

{
    "check_legacy_language_path": false,
    "check_legacy_strings_xml": true,
    "check_license_file_exists": true,
    "comment_on_pull": true
}

mzfr · 2018-02-24T16:57:34Z

@razzeee Are there any other changes required in this ?

razzeee · 2018-02-25T19:44:15Z

I'm a bit short on review time at the moment. The only thing you could do is sqash your commits if you know how to do that :)

razzeee · 2018-02-25T20:20:56Z

I think the travis ci file also needs changes as you added some dependencies that are not installed on ci otherwise

razzeee · 2018-02-26T20:27:09Z

I took the liberty to add requests in the travis.yml examples

razzeee · 2018-02-26T21:57:15Z

It's not perfect yet, check https://github.com/Razzeee/repo-plugins/pull/1 for an example.

I'm not sure if it might be prettier to show the errors in a markdown list? Might get very long, but at least you don't need to scroll horizontally.

check_repo.py

+            GithubAPI().remove_label(["Checks failed"])
+            GithubAPI().set_label(["Checks passed"])
+    else:
+        colorPrint("No config file found", "7")


razzeee · 2018-02-28T00:19:14Z

Tested a bit more and it's failing quiet often due to

{'message': "API rate limit exceeded for 52.45.185.117. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.)", 'documentation_url': 'https://developer.github.com/v3/#rate-limiting'}

mzfr · 2018-02-28T10:32:47Z

@razzeee I have made the changes so now API Rate limit have increased from 60 to 5000(It's the maximum).

razzeee · 2018-02-28T16:55:35Z

Seems awy more relyable 🎉

But formatting is still off https://github.com/Razzeee/repo-plugins/pull/1#issuecomment-369303762

check_addon.py


 def _logProblem(error_counter, problem_string):
    colorPrint("PROBLEM: %s" % problem_string, "31")
+    comments.append("PROBLEM: %s" % problem_string)


mzfr · 2018-02-28T20:27:05Z

@razzeee I have made changes suggested by you

razzeee · 2018-02-28T22:40:58Z

This is perfect, thank you 🌮

And sorry for taking so long to review and having you go back so many times 💃

razzeee · 2018-03-11T12:51:12Z

Crap, would have been to easy.
Just tried to set it up and it keeps failing due to the GITHUB_TOKEN enviroment variable not being set anymore.
https://docs.travis-ci.com/user/pull-requests/#Pull-Requests-and-Security-Restrictions

mzfr · 2018-03-12T13:08:52Z

@razzeee Wow, this is bad. There must be some recourse against this, right? Considering so many other tools do this GitHub comments thing.

At worst, we would have to stop using Travis CI (just for commenting; we can continue using it for builds) and maybe dedicate our own server for commenting, which would work via GitHub/Travis events hook API. There are existing tools for this or we could try to come up with our own lean implementation in Python. for. eg. this is how TravisBuddy's comments look, notice that they are on a pull created from a fork of the repo.

But perhaps there is a better way to deal with this?

MartijnKaijser · 2018-03-12T13:15:51Z

I think we'll have to add some github hook which we can grant access to be able to comment

razzeee · 2018-03-12T14:25:27Z

Well that travis buddy is running on their own infrastructure which obviously can keep the api key secret. While we try to let travis do that for us :/

mzfr · 2018-03-12T14:59:18Z

Yeah, but Travis isn't able to fulfill what we want, right? and I looked into this a bit more and it seems like tools like TravisBuddy are our best bet but yes we'll need our own infrastructure for that, if we want to customise the comments that we post.

Rechi reviewed Feb 11, 2018

View reviewed changes

razzeee reviewed Feb 11, 2018

View reviewed changes

check_addon.py Outdated

def _logProblem(error_counter, problem_string):

colorPrint("PROBLEM: %s" % problem_string, "31")

comments.append("PROBLEM: %s" % problem_string)

This comment was marked as spam.

Sign in to view

razzeee reviewed Feb 12, 2018

View reviewed changes

mzfr force-pushed the auto-comment branch from f36bd7f to be0ae6f Compare February 24, 2018 16:43

mzfr force-pushed the auto-comment branch 4 times, most recently from be0ae6f to fb30e47 Compare February 26, 2018 14:34

Auto comments issues found on pull requests

0b18055

mzfr force-pushed the auto-comment branch from fb30e47 to 0b18055 Compare February 26, 2018 14:41

show errors in markdown list

671ee8a

mzfr force-pushed the auto-comment branch from b5ef9f7 to 671ee8a Compare February 27, 2018 19:17

Minor changes

111e0da

razzeee reviewed Feb 27, 2018

View reviewed changes

check_repo.py Outdated

GithubAPI().remove_label(["Checks failed"])

GithubAPI().set_label(["Checks passed"])

else:

colorPrint("No config file found", "7")

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

Increase API rate limit

592e579

razzeee reviewed Feb 28, 2018

View reviewed changes

check_addon.py Outdated

def _logProblem(error_counter, problem_string):

colorPrint("PROBLEM: %s" % problem_string, "31")

comments.append("PROBLEM: %s" % problem_string)

This comment was marked as spam.

Sign in to view

Improve comment format

01791d5

razzeee merged commit acc1986 into xbmc:master Feb 28, 2018

mzfr mentioned this pull request Mar 12, 2018

Add resolvers for other test libraries bluzi/travis-buddy#3

Closed

mzfr mentioned this pull request Apr 2, 2018

Remove all the code and file used for github commenting. #62

Merged

mzfr deleted the auto-comment branch June 5, 2018 09:24

Conversation

mzfr commented Feb 11, 2018

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

razzeee commented Feb 11, 2018

Uh oh!

mzfr commented Feb 12, 2018

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

mzfr commented Feb 15, 2018

Uh oh!

mzfr commented Feb 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mzfr commented Feb 24, 2018

Uh oh!

razzeee commented Feb 25, 2018

Uh oh!

razzeee commented Feb 25, 2018

Uh oh!

razzeee commented Feb 26, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

razzeee commented Feb 26, 2018

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

razzeee commented Feb 28, 2018

Uh oh!

mzfr commented Feb 28, 2018

Uh oh!

razzeee commented Feb 28, 2018

Uh oh!

This comment was marked as spam.

Uh oh!

mzfr commented Feb 28, 2018

Uh oh!

razzeee commented Feb 28, 2018

Uh oh!

razzeee commented Mar 11, 2018

Uh oh!

mzfr commented Mar 12, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MartijnKaijser commented Mar 12, 2018

Uh oh!

razzeee commented Mar 12, 2018

Uh oh!

mzfr commented Mar 12, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mzfr commented Feb 16, 2018 •

edited

Loading

razzeee commented Feb 26, 2018 •

edited

Loading

mzfr commented Mar 12, 2018 •

edited

Loading