GithubHelp home page GithubHelp logo

Create a TCK about microprofile-open-api HOT 7 CLOSED

arthurdm avatar arthurdm commented on June 22, 2024
Create a TCK

from microprofile-open-api.

Comments (7)

mrglavas avatar mrglavas commented on June 22, 2024

@arthurdm I'm currently working on the skeleton for the TCK. Can you assign this one to me? Thanks.

from microprofile-open-api.

arthurdm avatar arthurdm commented on June 22, 2024

Unfortunately the Assignee field only picks from the committers list, so can't assign. But it's recorded here that @mrglavas is currently working on this issue.

from microprofile-open-api.

mrglavas avatar mrglavas commented on June 22, 2024

Breakdown of TCK test scenarios:

API:

  • Direct testing of OpenAPI model construction through OASFactory.
  • Check that each method on model interfaces can be executed.
  • Check that each getter method on model returns what was set with setter or builder method.
  • Test any other factory method that gets added for filtering, etc...
  • Negative testing for bad input (e.g. non-model interface passed to OASFactory.createObject()).

REST endpoints:

  • Test driver which accesses the OpenAPI document endpoint and verifies that it returns the correct output.
  • Test the endpoint with Accept headers (application/yaml and application/json)
  • Develop input for the test driver that covers all of the various documentation mechanisms.
    -- Configuration values for mp.openapi namespace
    -- OASModelReader
    -- OASFilter
    -- Static OpenAPI file (YAML / JSON)
    -- Annotated JAX-RS applications (covers OpenAPI annotations + JAX-RS annotations)

Utilities:

  • May require an OpenAPI parser to help with comparing expected output.

from microprofile-open-api.

mrglavas avatar mrglavas commented on June 22, 2024

I am currently working on the model construction test.

from microprofile-open-api.

arthurdm avatar arthurdm commented on June 22, 2024

Looks good @mrglavas ! My only comment is that the query parameter (format) is an optional part of the spec, so the TCK should be testing with the Accept header (application/yaml and application/json).

from microprofile-open-api.

mrglavas avatar mrglavas commented on June 22, 2024

Thanks @arthurdm. I've updated the description.

from microprofile-open-api.

arthurdm avatar arthurdm commented on June 22, 2024

Closing this as we have other issues to handle the remaining TCK portions

from microprofile-open-api.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.