') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); })(); [Spec] adds XmlItem model and route for xml testing by spacether · Pull Request #1808 · OpenAPITools/openapi-generator · GitHub
Skip to content

[Spec] adds XmlItem model and route for xml testing - #1808

Closed
spacether wants to merge 20 commits into
OpenAPITools:masterfrom
spacether:issue_1807_adds_xml_model
Closed

[Spec] adds XmlItem model and route for xml testing#1808
spacether wants to merge 20 commits into
OpenAPITools:masterfrom
spacether:issue_1807_adds_xml_model

Conversation

@spacether

@spacetherspacether commented Jan 3, 2019•
edited
Loading

Copy link
Copy Markdown
Contributor

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
  • Filed the PR against the correct branch: master, 3.4.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.
    @wing328
    @jimschubert
    @cbornet
    @jaz-ah
    @ackintosh
    @JFCote
    @jmini

Description of the PR

  1. This PR adds the model XmlItem and a route that uses it to the swagger 2.0 sample spec.
    It also includes 6 xml mime types that are produced + consumed in that route.
    Downstream clients can use this model and that route for their xml tests.
  2. It adds an Api suffix on the java rest-assured client to pass CircleCi tests
  3. It pegs the versions of pytest and pytest-cov to fix and pass TravisCI tests
  4. It fixes the python models get_real_child_model method so deserialization tests pass
  5. Removes unused models and tests from the sample python clients

The examples currently in the spec do not include all xml attributes. The XmlItem model includes all xml attributes:

  • name
  • attribute
  • wrapped
  • prefix

Issue Closure

When merged this PR will close these issues:

@spacetherspacether changed the title [SPEC] 2.0 adds XmlItem model and route for xml testing[Spec] 2.0 adds XmlItem model and route for xml testingJan 3, 2019
@spacetherspacether changed the title [Spec] 2.0 adds XmlItem model and route for xml testing[Spec] adds XmlItem model and route for xml testingJan 3, 2019
@wing328

wing328 commented Jan 5, 2019

Copy link
Copy Markdown
Member

@spacether according to the CircleCI log, here is the issue:

[ERROR] /home/circleci/OpenAPITools/openapi-generator/samples/client/petstore/java/rest-assured/src/main/java/org/openapitools/client/ApiClient.java:[42,22] <identifier> expected
[ERROR] /home/circleci/OpenAPITools/openapi-generator/samples/client/petstore/java/rest-assured/src/main/java/org/openapitools/client/ApiClient.java:[42,30] illegal start of type
[ERROR] /home/circleci/OpenAPITools/openapi-generator/samples/client/petstore/java/rest-assured/src/main/java/org/openapitools/client/ApiClient.java:[42,31] <identifier> expected
[ERROR] /home/circleci/OpenAPITools/openapi-generator/samples/client/petstore/java/rest-assured/src/main/java/org/openapitools/client/ApiClient.java:[42,32] ';' expected
[ERROR] /home/circleci/OpenAPITools/openapi-generator/samples/client/petstore/java/rest-assured/src/main/java/org/openapitools/client/ApiClient.java:[43,9] illegal start of type
[ERROR] /home/circleci/OpenAPITools/openapi-generator/samples/client/petstore/java/rest-assured/src/main/java/org/openapitools/client/ApiClient.java:[43,26] ';' expected

but I don't see changes to that file in this PR. I just restarted the CircleCI job to see if the result will be different.

@spacether

spacether commented Jan 5, 2019•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

@wing328 that file was modified by me re-generating all sample clients.
The first Java error says:

[ERROR] /home/circleci/OpenAPITools/openapi-generator/samples/client/petstore/java/rest-assured/src/main/java/org/openapitools/client/ApiClient.java:[42,22] <identifier> expected

That line is:
public DefaultApi default() {
And position 22 is right after DefaultApi. Is default a reserved keyword in Java?
It looks like it is per: https://en.wikipedia.org/wiki/List_of_Java_keywords
My guess is that someone updated the java generator without regenerating the java client, and now that I regenerated the client we now see this error.

Where is the rest-assured java generator file?
Any Idea on how to fix this?
Can I use setReservedWordsLowerCase?

wing328
wing328 reviewed Jan 6, 2019
View reviewed changes
Comment thread...penapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml Outdated

@wing328wing328Jan 6, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@spacether I think you will need to add 2 more spaces to indent the new fake endpoint so that it will be grouped into the previous endpoint POST /fake/{petId}/uploadImageWithRequiredFile

@spacetherspacetherJan 6, 2019•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wing328 Why do you think I need to further indent it?
The code I added creates a new route /fake/create_xml_item which has a post method.
Looking at higher up examples, my indenting is consistent with the definition of other routes.
Indent 2 spaces for the route
Indent 4 spaces for the method

This test must be a post route so we can submit a body.
Are you suggesting that I move the XmlItem body into the existing uploadImageWithRequiredFile post route?
I'd prefer to keep them separate as they test different features.

Did you see my comment above about the word default in Java?

@wing328wing328Jan 10, 2019•
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do you think I need to further indent it?

/fake/create_xml_item is put in the DefaultAPI class (a new class) so I don't think it's grouped under the same tags in the previous endpoint. Please change the indention to give it a try. (ideally I want to avoid another new class for a new fake endpoint)

@spacetherspacetherJan 11, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was the missing tag that made the route generate a new defaultapi file. Adding the tag fixed it.

@spacether

spacether commented Jan 6, 2019•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Further investigation shows that the default text in the file ApiClient.java is causing the CI test to fail. I have filed a bug on it here: #1831
and will include a mustache fix in this PR to get the rest-assured tests to pass.

spacether
spacether commented Jan 6, 2019
View reviewed changes
Comment threadmodules/openapi-generator/src/main/resources/Java/libraries/rest-assured/api.mustache Outdated
@spacether

spacether commented Jan 7, 2019•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

TravisCI Tests:

@wing328 the TravisCI tests were failing due to having different versions of pytest and pytest-cov installed. We had pytest==4.1.0, and pytest-cov==2.6.0. That version of pytest needed the latest version of pytest-cov==2.6.1.

So I pegged our versions of pytest and pytest-cov to the working values of:
pytest>=3.6.0
pytest-cov>=2.6.1
to ensure that this does not happen again in the future.

@spacether
Adds sample updates
17473fc
@spacether
Tweaked to re-run ci tests
fd70cb4
@spacether
Tweaked again for CI tests
6a1246e
@spacether
Adds Api suffix to java rest-assured client api, updates rest-assured…
ea8abc1
… sample client
@spacether
Adds other missing Api suffixes in rest-assured api client mustache f…
e7f4fcc
…iles
@spacether
rest-assured samples update
52b3cb4
@spacether
Removes orphaned test from java rest-assured sample client
b0a8e8e
@spacether
Adds fix for TravisCI tests
4b6bcaf
@spacether
Pegs pytest and pytest-cov to range ending in last working version
abec81e
@spacether
Pegs pytest>=3.6.0 and pytest-cov>=2.6.1 to ensure python TravisCI te…
a0effed
…sts will pass
@spacether
Adds updated python samples models
974e3fb
@spacether
Adds discriminator fixes to python-asyncio and python-tornado
a571637
@spacether
Removes unused animal_farm and string_boolean_map models and tests fr…
6552b16
…om python samples
@spacether
Adds comment to ignore max line length in one line of the python mode…
9d90a90
…l mustache file so nosetests pass
@spacether
Also adds the nosetest fix for the python-security sample
b65a991
@spacether
spacetherforce-pushed the issue_1807_adds_xml_model branch from 64968aa to b65a991CompareJanuary 10, 2019 17:42
@spacether

spacether commented Jan 11, 2019

Copy link
Copy Markdown
ContributorAuthor

Making a new pull request is easier than cleaning this one up. I will make a new one.

@spacetherspacether mentioned this pull request Jan 11, 2019
Merged
4 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@wing328wing328wing328 left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@spacether@wing328