Jira POST & PUT Rest Call возвращает ошибку 400 от Python - PullRequest
Новая
       66

Jira POST & PUT Rest Call возвращает ошибку 400 от Python

0 голосов
/ 24 апреля 2018

Я сталкиваюсь с действительно странной проблемой с API Jira Rest - где бы я ни пытался создать проблему, используя POST-запрос, или обновить ее с помощью запроса PUT, чтобы jira / rest / api / latest / issue / я получил код ошибки 400 из запросов Python 2.7, но он успешно выполняется из запроса веб-запроса Powershell.

Однако я могу получить информацию с сервера Jira с помощью GET-запросов, в том числе:

  • Список проектов
  • Список IssueTypes
  • Список пользовательских полей
  • Проблемы данного типа для данного проекта
  • Выполнение теста зефирного плагина
  • Тестовые циклы зефирного плагина

Я уже пробовал несколько предложений по устранению неполадок из аналогичных тем с сайта поддержки Atlassian:

  • Я проверил правильность Авторизации (это также требуется для запросов GET, которые все работают)
  • Я тестирую учетную запись с правами администратора на уровне экземпляра Jira
  • Я разделил json только на поля и формат, соответствующий документации REST API, здесь: jira-rest-api-examples / # creation-an-issue-examples
  • Я гарантировал, что все соответствующие файлы cookie и данные заголовка сессии сохранены и добавлены к следующим запросам
  • Я проверил через Issue / createmeta, что у меня есть возможность создать этот тип проблемы (и, как я уже говорил ранее, он работает в Powershell)
  • Я пытался использовать имя и идентификатор Issuetype, а также ключ и идентификатор проекта в качестве идентификатора, ни один из них ничего не меняет
  • Я даже пытался и пропустить, и включить косую черту в пути / issue на случай, если это важно
  • Я убедился, что это не тот случай, когда пользовательский агент Python блокируется для запросов POST / PUT

Json Body (Raw): 

{"fields": {"issuetype": {"id": "10702"}, "project": {"id": "10061"}, "description": "Execution for Issue: SDBX-859", "summary": "Execution for Issue: SDBX-859"}}

(отформатировано для разборчивости): 

{
    "fields": {
        "issuetype": {
            "id": "10702"
        },
        "project": {
            "id": "10061"
        },
        "description": "Execution for Issue: SDBX-859",
        "summary": "Execution for Issue: SDBX-859"
    }
}

Ход процесса начинается с этого класса: 

class Migrator(object):
    RestURLs = {
        "projects": "api/latest/project",
        "issuetype": "api/latest/issuetype",
        "fields": "api/latest/field",
        "tests": "api/latest/search?maxResults={limit}&expand=meta&jql=IssueType='{testType}'+and+project={projectKey}",
        "zSteps": "zapi/latest/teststep/{issueId}",
        "zExecutions": "zapi/latest/zql/executeSearch?zqlQuery=project={projectKey}",
        "zCycles": "zapi/latest/cycle?projectId={projectId}",
        "issue": "api/latest/issue/{issueKey}",
        "xSteps": "raven/1.0/api/test/{issueKey}/step/{stepId}",
        "xSet": "raven/1.0/api/testset/{issueKey}/test",
        "xExecution": "raven/1.0/api/testexec/{issueKey}/test"
    }

    CustomFields = {
        "Zephyr Teststep": "",
        "Manual Test Steps": "",
        "Test Type": ""
    }

    IssueNames = {
        "zephyr":"Zephyr - Test",
        "xray":"Test",
        "set":"Test Set",
        "execution":"Test Execution"
    }
    IssueTypes = {}

def __init__(self):
    self.results = []
    print("new Migrator initialised")
    self.restHandler = RestHandler()
    self.baseURL = "http://127.0.0.1/jira/rest/"
    self.authentication = ""
    self.commonHeaders = {}
    self.projectList = []
    self.project = None
    self.testList = []
    self.executionList = {}
    self.versionList = set()
    self.cycleList = {}
    self.setList = []

def connect(self, username, password, serverUrl="http://127.0.0.1"):
    # 1 - connect to jira
    if serverUrl[-1] != '/':
        serverUrl += '/'
    self.baseURL = str.format("{0}jira/rest/", serverUrl)
    self.authentication = "Basic " + base64.b64encode(username + ":" + password)
    self.commonHeaders = {"Authorization": self.authentication}

    print("Connecting to Server: " + self.baseURL)
    headers = self.commonHeaders
    projList = self.restHandler.perform(method=HTTP.GET,url=self.baseURL,path=Migrator.RestURLs["projects"],headers=headers)

    # 2 - populate projects list
    for projDict in projList:
        self.projectList.append(Project().fromDict(projDict))

из этого метода: 

    def migrateExecutions(self, project):
        print "working..."
        for execution in self.executionList:
            # Restricting it only to my issues for testing...
            if execution.assigneeUserName == "boydnic":
                headers = self.commonHeaders
                execData = {"fields":{}}
                execData["fields"]["issuetype"] = {"id":self.IssueTypes[self.IssueNames["execution"]].id}
                execData["fields"]["project"] = {"id":project.id}
#                execData["fields"]["reporter"] = {"name": userName}
#                execData["fields"]["assignee"] = {"name": execution.assigneeUserName}
                execData["fields"]["summary"] = "Execution for Issue: " + execution.issueKey
                execData["fields"]["description"] = execution.comment if execution.comment else execData["fields"]["summary"]

                xrayExec = self.createIssue(execData)
                self.results.append(self.restHandler.perform(method=HTTP.POST, url=self.baseURL,
                                         path=self.RestURLs["xExecution"], urlData={"issueKey":xrayExec.key},
                                         headers=headers, body={"add":[execution.issueKey]}))

к этому методу: 

def createIssue(self, issueTemplate):
    result = self.restHandler.perform(method=HTTP.POST, url=self.baseURL, path=Migrator.RestURLs["issue"], urlData={"issueKey":""}, headers=self.commonHeaders, body=issueTemplate)
    issue = Issue()
    issue.id = result["id"]
    issue.key = result["key"]
    issue.self = result["self"]
    print("Created Issue: "+issue.key)
    return issue

Который сам называет этот класс: 

class RestHandler(object):
    def __init__(self):
        self.headerStore = {'X-CITNET-USER':"",
                            'X-ASEN':"",
                            'X-ASESSIONID':"",
                            'X-AUSERNAME':""}
        self.cookieJar = requests.cookies.RequestsCookieJar()

    def perform(self, method, url, path, headers={}, urlData={"projectId": "", "projectKey": "", "issueId": "", "issueKey": ""},
                formData=dict(), body=""):
        resultData = "{}"
        path = url + path.format(**urlData)
        body = body if isinstance(body, str) else json.dumps(body)
        if self.headerStore:
            headers.update(self.headerStore)
        jar = self.cookieJar
        print(str(method))
        print(path)
        if method is HTTP.GET:
            resultData = requests.get(path, headers=headers, cookies = jar)
        elif method is HTTP.POST:
            print (body)
            path = path.rstrip('/')
            resultData = requests.post(path, json=body, headers=headers, cookies = jar)
        elif method is HTTP.PUT:
            print (body)
            resultData = requests.put(path, json=body, headers=headers, cookies = jar)
        elif method is HTTP.DELETE:
            request = "DELETE request to " + path
        else:
            raise TypeError
        print("\n\n===============================\nRest Call Debugging\n===============================")
        print(resultData)
        print(resultData.url)
        print(resultData.status_code)
        print(resultData.headers)
        print(resultData.content)
        print("\n\n===============================\n/Rest Call Debugging\n==============================")
        if 199 < resultData.status_code < 300:
            for hKey, hValue in resultData.headers.iteritems():
                if hKey in self.headerStore.keys():
                    self.headerStore[hKey] = hValue
            self.cookieJar.update(resultData.cookies)
            print "testing breakpoint"
            return json.loads(resultData.content)
        else:
            raise IOError(resultData.reason)

Секция отладки, включенная в класс Rest Handler, просто выплевывает следующее: 

===============================
Rest Call Debugging
===============================
https://webgate.test.ec.europa.eu/CITnet/jira/rest/api/latest/issue
400
{'X-AUSERNAME': 'boydnic', 'X-AREQUESTID': '<redacted>', 'X-Content-Type-Options': 'nosniff', 'Transfer-Encoding': 'chunked', 'Set-Cookie': 'crowd.token_key=""; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly, crowd.token_key=<redacted>; Path=/; HttpOnly, JSESSIONID=<redacted>; Path=/CITnet/jira; HttpOnly, atlassian.xsrf.token=<redacted>; Path=/CITnet/jira', 'X-Seraph-LoginReason': 'OUT, OK', 'X-ASEN': '<redacted>', 'X-CITNET-USER': 'boydnic', 'Connection': 'Keep-Alive', 'X-ASESSIONID': '<redacted>', 'Cache-Control': 'no-cache, no-store, no-transform, proxy-revalidate', 'Date': 'Tue, 24 Apr 2018 08:29:16 GMT', 'Server': 'Apache-Coyote/1.1', 'Content-Type': 'application/json;charset=UTF-8'}
{"errorMessages":["Can not instantiate value of type [simple type, class com.atlassian.jira.rest.v2.issue.IssueUpdateBean] from JSON String; no single-String constructor/factory method"]}


===============================
/Rest Call Debugging
==============================

С этой ошибкой ввода / вывода, смешанной с ней:

(я распутал потоки STD и ERR для этого поста) 

Traceback (most recent call last):   File
"C:/Users/BOYDnic/Documents/migrator/issueMigrator.py", line 546, in
<module> <Response [400]>
    jiraMigrator.migrate(projectKey)
      File "C:/Users/BOYDnic/Documents/migrator/issueMigrator.py", line 330, in migrate
    self.migrateExecutions(project)   File "C:/Users/BOYDnic/Documents/migrator/issueMigrator.py", line 475, in
migrateExecutions
    xrayExec = self.createIssue(execData)   File "C:/Users/BOYDnic/Documents/migrator/issueMigrator.py", line 334, in
createIssue
    result = self.restHandler.perform(method=HTTP.POST, url=self.baseURL, path=Migrator.RestURLs["issue"],
urlData={"issueKey":""}, headers=self.commonHeaders,
body=issueTemplate)   File
"C:/Users/BOYDnic/Documents/migrator/issueMigrator.py", line 84, in
perform
    raise IOError(resultData.reason) IOError: Bad Request

Я невероятно разочарован этим, не в последнюю очередь потому, что он блокирует завершение этого сценария миграции и, похоже, не имеет смысла.

Ответы [ 2 ]

0 голосов
/ 25 апреля 2018

Оказалось, что именно мое использование json.dumps(body) в сочетании с put(..., json=body, ...) вызвало проблему.

Использование ключевого слова json указывает Requests на повторную сериализацию строки, избегая "marks to \"и снова заключить его в кавычки.

Эффективно: 

{"fields": {"issuetype": {"id": 10702},"project": {"id":10061},"description": "","summary": "Execution for Issue: SDBX-859"}}

Стал: 

"{\"fields\": {\"issuetype\": {\"id\": \"10702\"}, \"project\": {\"id\": \"10061\"}, \"description\": \"Execution for Issue: SDBX-859\", \"summary\": \"Execution for Issue: SDBX-859\"}}"

Использовать body=json.dumps({...}) с установленным вручную заголовком содержимого или json={...} неи.

0 голосов
/ 24 апреля 2018

Jira возвращает ошибки типа «Не удается создать экземпляр значения типа ...», когда тело запроса неправильно отформатировано. В вашем случае вы указали строку, в которой Jira ожидает более сложное содержимое (обычно это dict).

...