mirror of https://github.com/kubeshark/kubeshark.git synced 2025-08-06 19:14:50 +00:00

M. Mert Yıldıran 145e7cda01

Add OAS contract monitoring support (#325 )

* Add OAS contract monitoring support

* Pass the contract failure reason to UI

* Fix the issues related to contract validation

* Fix rest of the issues in the UI

* Add documentation related to contract monitoring feature

* Fix a typo in the docs

* Unmarshal to `HTTPRequestResponsePair` only if the OAS validation is enabled

* Fix an issue caused by the merge commit

* Slightly change the logic in the `validateOAS` method

Change the `contractText` value to `No Breaches` or `Breach` and make the text `white-space: nowrap`.

* Retrieve and display the failure reason for both request and response

Also display the content of the contract/OAS file in the UI.

* Display the OAS under `CONTRACT` tab with syntax highlighting

Also fix the styling in the entry feed.

* Remove `EnforcePolicyFileDeprecated` constant

* Log the other errors as well

* Get context from caller instead

* Define a type for the contract status and make its values enum-like

* Remove an unnecessary `if` statement

* Validate OAS in the CLI before passing it to Agent

* Get rid of the `github.com/ghodss/yaml` dependency in `loadOAS` by using `LoadFromData`

* Fix an artifact from the merge conflict

2021-10-19 14:24:22 +03:00

4.0 KiB

Raw Permalink Blame History

OpenAPI Specification (OAS) Contract Monitoring

An OAS/Swagger file can contain schemas under parameters and responses fields. With --contract catalogue.yaml CLI option, you can pass your API description to Mizu and the traffic will automatically be validated against the contracts.

Below is an example of an OAS/Swagger file from Sock Shop microservice demo that contains a bunch contracts:

openapi: 3.0.1
info:
  title: Catalogue resources
  version: 1.0.0
  description: ""
  license:
    name: MIT
    url: http://github.com/gruntjs/grunt/blob/master/LICENSE-MIT
paths:
  /catalogue:
    get:
      description: Catalogue API
      operationId: List catalogue
      responses:
        200:
          description: ""
          content:
            application/json;charset=UTF-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Listresponse'
  /catalogue/{id}:
    get:
      operationId: Get an item
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        example: a0a4f044-b040-410d-8ead-4de0446aec7e
      responses:
        200:
          description: ""
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/Getanitemresponse'
  /catalogue/size:
    get:
      operationId: Get size
      responses:
        200:
          description: ""
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/Getsizeresponse'
  /tags:
    get:
      operationId: List_
      responses:
        200:
          description: ""
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/Listresponse3'
components:
  schemas:
    Listresponse:
      title: List response
      required:
      - count
      - description
      - id
      - imageUrl
      - name
      - price
      - tag
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        imageUrl:
          type: array
          items:
            type: string
        price:
          type: number
          format: double
        count:
          type: integer
          format: int32
        tag:
          type: array
          items:
            type: string
    Getanitemresponse:
      title: Get an item response
      required:
      - count
      - description
      - id
      - imageUrl
      - name
      - price
      - tag
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        imageUrl:
          type: array
          items:
            type: string
        price:
          type: number
          format: double
        count:
          type: integer
          format: int32
        tag:
          type: array
          items:
            type: string
    Getsizeresponse:
      title: Get size response
      required:
      - size
      type: object
      properties:
        size:
          type: integer
          format: int32
    Listresponse3:
      title: List response3
      required:
      - tags
      type: object
      properties:
        tags:
          type: array
          items:
            type: string

Pass it to Mizu through the CLI option: mizu tap -n sock-shop --contract catalogue.yaml

Now Mizu will monitor the traffic against these contracts.

If an entry fails to comply with the contract, it's marked with Breach notice in the UI. The reason of the failure can be seen under the CONTRACT tab in the details layout.

Notes

Make sure that you;

specified the openapi version
specified the info.version version in the YAML
and removed servers field from the YAML

Otherwise the OAS file cannot be recognized. (see this issue)

4.0 KiB Raw Permalink Blame History

OpenAPI Specification (OAS) Contract Monitoring

Notes

4.0 KiB

Raw Permalink Blame History