org.apiaddicts.apitools.dosonarapi.checks.DefinedResponseCheck Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openapi-checks Show documentation
The newest version!
/*
 * doSonarAPI: SonarQube OpenAPI Plugin
 * Copyright (C) 2021-2022 Apiaddicts
 * contacta AT apiaddicts DOT org
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.apiaddicts.apitools.dosonarapi.checks;

import com.google.common.collect.Sets;
import com.sonar.sslr.api.AstNodeType;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import org.sonar.check.Rule;
import org.apiaddicts.apitools.dosonarapi.api.OpenApiCheck;
import org.apiaddicts.apitools.dosonarapi.api.v2.OpenApi2Grammar;
import org.apiaddicts.apitools.dosonarapi.api.v3.OpenApi3Grammar;
import org.apiaddicts.apitools.dosonarapi.sslr.yaml.grammar.JsonNode;

@Rule(key = DefinedResponseCheck.CHECK_KEY)
public class DefinedResponseCheck extends OpenApiCheck {
  protected static final String CHECK_KEY = "DefinedResponse";
  private static final String MESSAGE_NO_RESPONSE = "Define the responses of your operations.";
  private static final String MESSAGE_NO_MODEL = "Define the model of your response.";

  @Override
  public Set subscribedKinds() {
    return Sets.newHashSet(
      OpenApi2Grammar.RESPONSES, OpenApi3Grammar.RESPONSES);
  }

  @Override
  protected void visitNode(JsonNode node) {
    Map properties = node.propertyMap();
    if (properties.isEmpty()) {
      addIssue(MESSAGE_NO_RESPONSE, node.key());
    } else if (node.getType() == OpenApi2Grammar.RESPONSES) {
      visitV2Responses(properties);
    } else {
      visitV3Responses(properties);
    }
  }

  private void visitV2Responses(Map responses) {
    JsonNode defaultResponse = responses.remove("default");
    boolean hasDefaultSchema = defaultResponse != null && visitResponseV2OrMediaType(defaultResponse, false);

    for (Map.Entry entry : responses.entrySet()) {
      visitResponseV2OrMediaType(entry.getValue(), hasDefaultSchema);
    }
  }

  private boolean visitResponseV2OrMediaType(JsonNode node, boolean hasDefaultContent) {
    JsonNode actual = node.resolve();
    Map properties = actual.propertyMap();
    if (!properties.containsKey("schema") && !hasDefaultContent) {
      addIssue(MESSAGE_NO_MODEL, node.key());
      return false;
    }
    return true;
  }

  private void visitV3Responses(Map responses) {
    JsonNode defaultResponse = responses.remove("default");
    Map defaultSchemas = new HashMap<>();
    if (defaultResponse != null) {
      defaultSchemas.putAll(visitResponseV3(defaultResponse, Collections.emptyMap()));
    }

    for (Map.Entry entry : responses.entrySet()) {
      visitResponseV3(entry.getValue(), defaultSchemas);
    }
  }

  private Map visitResponseV3(JsonNode node, Map defaultSchemas) {
    Map contents = getContents(node);
    if (contents.isEmpty() && defaultSchemas.isEmpty()) {
      addIssue(MESSAGE_NO_MODEL, node.key());
      return Collections.emptyMap();
    } else {
      Map result = new HashMap<>();
      for (Map.Entry entry : contents.entrySet()) {
        Boolean isDefaultValid = defaultSchemas.get(entry.getKey());
        boolean hasDefaultSchema = isDefaultValid != null && isDefaultValid;
        result.put(entry.getKey(), visitResponseV2OrMediaType(entry.getValue(), hasDefaultSchema));
      }
      return result;
    }
  }

  private Map getContents(JsonNode node) {
    JsonNode actual = node.resolve();
    Map properties = actual.propertyMap();
    JsonNode content = properties.get("content");
    if (content == null) {
      return Collections.emptyMap();
    } else {
      return content.propertyMap();
    }
  }
}