org.sonar.iac.docker.checks.utils.CheckUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-iac-docker Show documentation
The newest version!
/*
 * SonarQube IaC Plugin
 * Copyright (C) 2021-2023 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * 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.sonar.iac.docker.checks.utils;

import java.util.Collection;
import java.util.List;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.stream.Collectors;
import org.sonar.iac.common.api.checks.CheckContext;
import org.sonar.iac.docker.symbols.ArgumentResolution;
import org.sonar.iac.docker.tree.api.CommandInstruction;
import org.sonar.iac.docker.tree.api.DockerTree;
import org.sonar.iac.docker.tree.api.Flag;
import org.sonar.iac.docker.tree.api.HasArguments;

public final class CheckUtils {

  private CheckUtils() {
    // utils class
  }

  public static List resolveInstructionArguments(HasArguments instructionWithArguments) {
    return instructionWithArguments.arguments().stream().map(ArgumentResolution::ofWithoutStrippingQuotes).collect(Collectors.toList());
  }

  public static String getFileExtension(String name) {
    int lastIndexOf = name.lastIndexOf(".");
    if (lastIndexOf == -1) {
      // empty extension
      return "";
    }
    return name.substring(lastIndexOf + 1);
  }

  public static Optional getParamByName(Collection params, String name) {
    return params.stream().filter(param -> name.equals(param.name())).findFirst();
  }

  public static  BiConsumer ignoringHeredoc(BiConsumer visitor) {
    return (ctx, commandInstruction) -> {
      if (DockerTree.Kind.HEREDOCUMENT != commandInstruction.getKindOfArgumentList()) {
        visitor.accept(ctx, commandInstruction);
      }
    };
  }

  /**
   * Only execute the visitor if this CommandInstruction is not an ExecForm.
   * 

   * Unlike the shell form, the exec form does not invoke a command shell. This means that normal shell processing does not happen.
   * Thus, checks about shell best practices are not applicable to commands in ExecForm.
   */
  public static  BiConsumer ignoringExecForm(BiConsumer visitor) {
    return (ctx, commandInstruction) -> {
      if (DockerTree.Kind.EXEC_FORM != commandInstruction.getKindOfArgumentList()) {
        visitor.accept(ctx, commandInstruction);
      }
    };
  }
}