OpenAPITools / OpenAPITools/openapi-diff

Doesn't detect/render additions to the API

Aperta
#230 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Java
Stelle
1.1k
Fork
190
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Try this....

See last exploratory test I added to the existing test case.
As a user it just seems totally broken?

package org.openapitools.openapidiff.core;

import io.swagger.parser.OpenAPIParser;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.Operation;
import io.swagger.v3.oas.models.PathItem;
import io.swagger.v3.oas.models.tags.Tag;
import io.swagger.v3.parser.core.models.SwaggerParseResult;
import org.junit.jupiter.api.Test;
import org.openapitools.openapidiff.core.model.Changed;
import org.openapitools.openapidiff.core.model.ChangedOpenApi;
import org.openapitools.openapidiff.core.output.ConsoleRender;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.openapitools.openapidiff.core.TestUtils.assertOpenApiAreEquals;
import static org.openapitools.openapidiff.core.model.DiffResult.COMPATIBLE;

public class PathDiffTest {

    private final String OPENAPI_PATH1 = "path_1.yaml";
    private final String OPENAPI_PATH2 = "path_2.yaml";
    private final String OPENAPI_PATH3 = "path_3.yaml";
    private final String OPENAPI_PATH4 = "path_4.yaml";

    @Test
    public void testEqual() {
        assertOpenApiAreEquals(OPENAPI_PATH1, OPENAPI_PATH2);
    }

    @Test
    public void testMultiplePathWithSameSignature() {
        assertThrows(
                IllegalArgumentException.class, () -> assertOpenApiAreEquals(OPENAPI_PATH3, OPENAPI_PATH3));
    }

    @Test
    public void testSameTemplateDifferentMethods() {
        ChangedOpenApi changedOpenApi = OpenApiCompare.fromLocations(OPENAPI_PATH1, OPENAPI_PATH4);
        assertThat(changedOpenApi.getNewEndpoints())
                .hasSize(1)
                .satisfiesExactly(endpoint -> assertThat(endpoint.getOperation().getOperationId()).isEqualTo("deletePet"));
        assertThat(changedOpenApi.isCompatible()).isTrue();
    }

    @Test
    void exploratoryTest() {

        // clean original spec
        OpenAPIParser parser = new OpenAPIParser();
        SwaggerParseResult origDoc = parser.readLocation(OPENAPI_PATH1, null, null);
        OpenAPI origOpenAPI = origDoc.getOpenAPI();

        // hacked copy of the same original
        SwaggerParseResult newDoc = parser.readLocation(OPENAPI_PATH1, null, null);
        OpenAPI newOpenAPI = newDoc.getOpenAPI();

        Tag tag = new Tag();
        tag.setDescription("ADDED TAG");
        tag.setName("ADDED TAGNAME");

        newOpenAPI.addTagsItem(tag);
        PathItem addedPathItem = new PathItem();
        addedPathItem.setDescription("ADDED PATH");
        Operation op = new Operation();
        op.setOperationId("ADDEDOPID");
        addedPathItem.setGet(op);
        newOpenAPI.getPaths().addPathItem("ADDEDPATH", addedPathItem);

        // now compare them
        ChangedOpenApi changedOpenApi = OpenApiCompare.fromSpecifications(origOpenAPI, newOpenAPI);
        assertThat(changedOpenApi.isChanged()).isEqualTo(COMPATIBLE); // ok so it knows something has changed??
        assertThat(changedOpenApi.isDifferent()).isEqualTo(true); // yep something has changed


        // but the reporting doesn't tell me what
        assertThat(changedOpenApi.getChangedElements()).hasSizeGreaterThan(0);
        System.out.println("---");
        System.out.println("CHANGES SIZE : " + changedOpenApi.getChangedElements().size());
        System.out.println("---");
        System.out.println("??!! THIS COMES BACK A [null] ie a null element !!: " + changedOpenApi.getChangedElements());
        System.out.println("---");
        System.out.println("diffs should surely render the additional elements that I added??  - but it does nothing??");
        ConsoleRender cr = new ConsoleRender();
        cr.render(changedOpenApi);
        System.out.println("!! some diff should have been printed above ");

        //assertThat(changedOpenApi.getMissingEndpoints()).hasSize(1);
        ///assertThat(changedOpenApi.isCompatible()).isTrue();

    }
}

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia con l'exploratoryTest in PathDiffTest e segui OpenApiCompare.fromSpecifications fino a ConsoleRender.render. Esegui il test per ispezionare changedElements e l'output della console per il tag, il path e l'operazione aggiunti; è completato quando tali aggiunte sono rappresentate e renderizzate, invece di produrre un elemento null o nessuna differenza.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java
Ambito
api, testing
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
30/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.