rcextensions: updated examples, and made http_call util use the method parameter.

- before it was ununsed by mistake.

rhodecode/config/rcextensions/examples/http_call_on_push.py

@@ -1,36 +1,37 b''
 # Example to trigger a HTTP call via an HTTP helper via post_push hook
 
 
 @has_kwargs({
     'server_url': 'url of instance that triggered this hook',
     'config': 'path to .ini config used',
     'scm': 'type of version control "git", "hg", "svn"',
     'username': 'username of actor who triggered this event',
     'ip': 'ip address of actor who triggered this hook',
     'action': '',
     'repository': 'repository name',
     'repo_store_path': 'full path to where repositories are stored',
     'commit_ids': '',
     'hook_type': '',
     'user_agent': '',
 })
 def _push_hook(*args, **kwargs):
     """
     POST PUSH HOOK, this function will be executed after each push it's
     executed after the build-in hook that RhodeCode uses for logging pushes
     """
 
     from .helpers import http_call, extra_fields
     # returns list of dicts with key-val fetched from extra fields
     repo_extra_fields = extra_fields.run(**kwargs)
 
     if repo_extra_fields.get('endpoint_url'):
-        endpoint = repo_extra_fields['endpoint_url']
+        field_metadata = repo_extra_fields['endpoint_url']
+        endpoint = field_metadata['field_value']
         if endpoint:
             data = {
-                'some_key': 'val'
+                'project': kwargs['repository'],
             }
-            response = http_call.run(url=endpoint, json_data=data)
-            return HookResponse(0, 'Called endpoint {}, with response {}'.format(endpoint, response))
+            response = http_call.run(url=endpoint, params=data)
+            return HookResponse(0, 'Called endpoint {}, with response {}\n'.format(endpoint, response))
 
     return HookResponse(0, '')

rhodecode/config/rcextensions/examples/trigger_ci_call.py

@@ -1,36 +1,37 b''
 # Example to trigger a CI call via an HTTP helper via post_push hook
 
 
 @has_kwargs({
     'server_url': 'url of instance that triggered this hook',
     'config': 'path to .ini config used',
     'scm': 'type of version control "git", "hg", "svn"',
     'username': 'username of actor who triggered this event',
     'ip': 'ip address of actor who triggered this hook',
     'action': '',
     'repository': 'repository name',
     'repo_store_path': 'full path to where repositories are stored',
     'commit_ids': '',
     'hook_type': '',
     'user_agent': '',
 })
 def _push_hook(*args, **kwargs):
     """
     POST PUSH HOOK, this function will be executed after each push it's
     executed after the build-in hook that RhodeCode uses for logging pushes
     """
 
     from .helpers import http_call, extra_fields
     # returns list of dicts with key-val fetched from extra fields
     repo_extra_fields = extra_fields.run(**kwargs)
 
     if repo_extra_fields.get('endpoint_url'):
-        endpoint = repo_extra_fields['endpoint_url']
+        field_metadata = repo_extra_fields['endpoint_url']
+        endpoint = field_metadata['field_value']
         if endpoint:
             data = {
                 'some_key': 'val'
             }
             response = http_call.run(url=endpoint, json_data=data)
             return HookResponse(0, 'Called endpoint {}, with response {}'.format(endpoint, response))
 
     return HookResponse(0, '')

rhodecode/config/rcextensions/examples/validate_commit_message_author.py

@@ -1,91 +1,92 b''
 # Example to validate commit message or author using some sort of rules
 
 
 @has_kwargs({
     'server_url': 'url of instance that triggered this hook',
     'config': 'path to .ini config used',
     'scm': 'type of version control "git", "hg", "svn"',
     'username': 'username of actor who triggered this event',
     'ip': 'ip address of actor who triggered this hook',
     'action': '',
     'repository': 'repository name',
     'repo_store_path': 'full path to where repositories are stored',
     'commit_ids': 'pre transaction metadata for commit ids',
     'hook_type': '',
     'user_agent': 'Client user agent, e.g git or mercurial CLI version',
 })
 @has_kwargs({
     'server_url': 'url of instance that triggered this hook',
     'config': 'path to .ini config used',
     'scm': 'type of version control "git", "hg", "svn"',
     'username': 'username of actor who triggered this event',
     'ip': 'ip address of actor who triggered this hook',
     'action': '',
     'repository': 'repository name',
     'repo_store_path': 'full path to where repositories are stored',
     'commit_ids': 'pre transaction metadata for commit ids',
     'hook_type': '',
     'user_agent': 'Client user agent, e.g git or mercurial CLI version',
 })
 def _pre_push_hook(*args, **kwargs):
     """
     Post push hook
     To stop version control from storing the transaction and send a message to user
     use non-zero HookResponse with a message, e.g return HookResponse(1, 'Not allowed')
 
     This message will be shown back to client during PUSH operation
 
     Commit ids might look like that::
 
     [{u'hg_env|git_env': ...,
       u'multiple_heads': [],
       u'name': u'default',
       u'new_rev': u'd0befe0692e722e01d5677f27a104631cf798b69',
       u'old_rev': u'd0befe0692e722e01d5677f27a104631cf798b69',
       u'ref': u'',
       u'total_commits': 2,
       u'type': u'branch'}]
     """
     import re
     from .helpers import extra_fields, extract_pre_commits
     from .utils import str2bool
 
     # returns list of dicts with key-val fetched from extra fields
     repo_extra_fields = extra_fields.run(**kwargs)
 
     # optionally use 'extra fields' to control the logic per repo
-    should_validate = str2bool(repo_extra_fields.get('validate_author', True))
+    validate_author = repo_extra_fields.get('validate_author', {}).get('field_value')
+    should_validate = str2bool(validate_author)
 
     # optionally store validation regex into extra fields
-    validation_regex = repo_extra_fields.get('validation_regex', '')
+    validation_regex = repo_extra_fields.get('validation_regex', {}).get('field_value')
 
     def validate_commit_message(commit_message, message_regex=None):
         """
         This function validates commit_message against some sort of rules.
         It should return a valid boolean, and a reason for failure
         """
 
         if "secret_string" in commit_message:
             msg = "!!Push forbidden: secret string found in commit messages"
             return False, msg
 
         if validation_regex:
             regexp = re.compile(validation_regex)
             if not regexp.match(message):
                 msg = "!!Push forbidden: commit message does not match regexp"
                 return False, msg
 
         return True, ''
 
     if should_validate:
         # returns list of dicts with key-val fetched from extra fields
         commit_list = extract_pre_commits.run(**kwargs)
 
         for commit_data in commit_list:
             message = commit_data['message']
 
             message_valid, reason = validate_commit_message(message, validation_regex)
             if not message_valid:
                 return HookResponse(1, reason)
 
     return HookResponse(0, '')

rhodecode/config/rcextensions/helpers/extra_fields.py

@@ -1,40 +1,55 b''
 # -*- coding: utf-8 -*-
 # Copyright (C) 2016-2018 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 """
-us in hooks::
+example usage in hooks::
 
     from .helpers import extra_fields
     # returns list of dicts with key-val fetched from extra fields
     repo_extra_fields = extra_fields.run(**kwargs)
+    repo_extra_fields.get('endpoint_url')
+
+    # the field stored the following example values
+    {u'created_on': datetime.datetime(),
+     u'field_key': u'endpoint_url',
+     u'field_label': u'Endpoint URL',
+     u'field_desc': u'Full HTTP endpoint to call if given',
+     u'field_type': u'str',
+     u'field_value': u'http://server.com/post',
+     u'repo_field_id': 1,
+     u'repository_id': 1}
+    # for example to obtain the value:
+    endpoint_field = repo_extra_fields.get('endpoint_url')
+    if endpoint_field:
+        url = endpoint_field['field_value']
 
 """
 
 
 def run(*args, **kwargs):
     from rhodecode.model.db import Repository
     # use temp name then the main one propagated
     repo_name = kwargs.pop('REPOSITORY', None) or kwargs['repository']
     repo = Repository.get_by_repo_name(repo_name)
 
     fields = {}
     for field in repo.extra_fields:
         fields[field.field_key] = field.get_dict()
 
     return fields

rhodecode/config/rcextensions/helpers/http_call.py

@@ -1,36 +1,49 b''
 # -*- coding: utf-8 -*-
 # Copyright (C) 2016-2018 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 """
 us in hooks::
 
     from .helpers import http_call
     # returns response after making a POST call
-    response = http_call.run(url=url, json_data=data)
+    response = http_call.run(url=url, json_data={"key": "val"})
+
+    # returns response after making a GET call
+    response = http_call.run(url=url, params={"key": "val"}, method='get')
 
 """
 
 from rhodecode.integrations.types.base import requests_retry_call
 
 
-def run(url, json_data, method='post'):
+def run(url, json_data=None, params=None, method='post'):
     requests_session = requests_retry_call()
     requests_session.verify = True  # Verify SSL
-    resp = requests_session.post(url, json=json_data, timeout=60)
-    return resp.raise_for_status()  # raise exception on a failed request
+    method_caller = getattr(requests_session, method, 'post')
+
+    timeout = 60
+    if json_data:
+        resp = method_caller(url, json=json_data, timeout=timeout)
+    elif params:
+        resp = method_caller(url, params=json_data, timeout=timeout)
+    else:
+        raise AttributeError('Provide json_data= or params= in function call')
+    resp.raise_for_status()  # raise exception on a failed request
+    return resp
+