content: /*******************************************************************************
   * Copyright (C) 2021, 1C-Soft LLC and others.
   *
   * This program and the accompanying materials are made
   * available under the terms of the Eclipse Public License 2.0
   * which is available at https://www.eclipse.org/legal/epl-2.0/
   *
   * SPDX-License-Identifier: EPL-2.0
   *
   * Contributors:
   *     1C-Soft LLC - initial API and implementation
   *******************************************************************************/
  package com.e1c.v8codestyle.bsl.strict.check.itests;
  
  import static org.junit.Assert.assertEquals;
  import static org.junit.Assert.assertNotNull;
  import static org.junit.Assert.assertTrue;
  
  import java.io.InputStream;
  import java.util.ArrayList;
  import java.util.Arrays;
  import java.util.List;
  import java.util.stream.Collectors;
  
  import org.eclipse.core.resources.IFile;
  import org.eclipse.core.resources.IProject;
  import org.eclipse.core.runtime.CoreException;
  import org.eclipse.core.runtime.NullProgressMonitor;
  import org.eclipse.emf.ecore.util.EcoreUtil;
  import org.eclipse.xtext.EcoreUtil2;
  import org.junit.Before;
  import org.junit.Test;
  
  import com._1c.g5.v8.bm.core.IBmObject;
  import com._1c.g5.v8.dt.bsl.model.DynamicFeatureAccess;
  import com._1c.g5.v8.dt.bsl.model.Function;
  import com._1c.g5.v8.dt.bsl.model.Method;
  import com._1c.g5.v8.dt.bsl.model.Module;
  import com._1c.g5.v8.dt.bsl.model.SimpleStatement;
  import com._1c.g5.v8.dt.bsl.model.StaticFeatureAccess;
  import com._1c.g5.v8.dt.bsl.model.StringLiteral;
  import com._1c.g5.v8.dt.bsl.model.Variable;
  import com._1c.g5.v8.dt.core.platform.IDtProject;
  import com._1c.g5.v8.dt.metadata.mdclass.CommonModule;
  import com._1c.g5.v8.dt.validation.marker.Marker;
  import com._1c.g5.v8.dt.validation.marker.StandardExtraInfo;
  import com.e1c.g5.v8.dt.testing.check.CheckTestBase;
  import com.e1c.v8codestyle.bsl.strict.check.DocCommentFieldTypeCheck;
  import com.e1c.v8codestyle.bsl.strict.check.DynamicFeatureAccessMethodNotFoundCheck;
  import com.e1c.v8codestyle.bsl.strict.check.DynamicFeatureAccessTypeCheck;
  import com.e1c.v8codestyle.bsl.strict.check.FunctionCtorReturnSectionCheck;
  import com.e1c.v8codestyle.bsl.strict.check.FunctionReturnTypeCheck;
  import com.e1c.v8codestyle.bsl.strict.check.InvocationParamIntersectionCheck;
  import com.e1c.v8codestyle.bsl.strict.check.MethodParamTypeCheck;
  import com.e1c.v8codestyle.bsl.strict.check.SimpleStatementTypeCheck;
  import com.e1c.v8codestyle.bsl.strict.check.StructureCtorValueTypeCheck;
  import com.e1c.v8codestyle.bsl.strict.check.StructureKeyModificationCheck;
  import com.e1c.v8codestyle.bsl.strict.check.TypedValueAddingToUntypedCollectionCheck;
  import com.e1c.v8codestyle.bsl.strict.check.VariableTypeCheck;
  
  /**
   * Tests of strict types system in BSL module.
   *
   * @author Dmitriy Marmyshev
   */
  public class CommonModuleStrictTypesTest
      extends CheckTestBase
  {
  
      private static final String PROJECT_NAME = "CommonModule";
  
      private static final String FQN = "CommonModule.CommonModule";
  
      private static final String FOLDER = "/resources/strict/";
  
      private static final String COMMON_MODULE_FILE_NAME = "/src/CommonModules/CommonModule/Module.bsl";
  
      private IDtProject dtProject;
  
      @Before
      public void setUp() throws CoreException
      {
  
          IProject project = testingWorkspace.getProject(getTestConfigurationName());
  
          if (!project.exists() || !project.isAccessible())
          {
              testingWorkspace.cleanUpWorkspace();
              dtProject = openProjectAndWaitForValidationFinish(getTestConfigurationName());
          }
          dtProject = dtProjectManager.getDtProject(project);
      }
  
      @Override
      protected boolean enableCleanUp()
      {
          return false;
      }
  
      protected String getTestConfigurationName()
      {
          return PROJECT_NAME;
      }
  
      /**
       * Test of {@link StructureCtorValueTypeCheck} structure constructor value has returning type.
       *
       * @throws Exception the exception
       */
      @Test
      public void testStructureCtorValueTypeCheck() throws Exception
      {
  
          String checkId = "structure-consructor-value-type";
  
          Module module = updateAndGetModule(checkId);
  
          List<StringLiteral> literals = EcoreUtil2.eAllOfType(module, StringLiteral.class);
          assertEquals(5, literals.size());
  
          List<Marker> markers = getMarters(checkId, module);
  
          assertEquals(2, markers.size());
  
          String uriToProblem = EcoreUtil.getURI(literals.get(0)).toString();
  
          Marker marker = markers.get(0);
  
          assertEquals(Integer.valueOf(5), marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE));
          assertEquals(uriToProblem, marker.getExtraInfo().get(StandardExtraInfo.TEXT_URI_TO_PROBLEM));
  
          marker = markers.get(1);
  
          assertEquals(Integer.valueOf(5), marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE));
          assertEquals(uriToProblem, marker.getExtraInfo().get(StandardExtraInfo.TEXT_URI_TO_PROBLEM));
  
      }
  
      /**
       * Test of {@link VariableTypeCheck} that each variable has value type.
       *
       * @throws Exception the exception
       */
      @Test
      public void testVariableTypeCheck() throws Exception
      {
  
          String checkId = "variable-value-type";
  
          Module module = updateAndGetModule(checkId);
  
          List<Variable> variables = EcoreUtil2.eAllOfType(module, Variable.class);
          assertEquals(4, variables.size());
  
          List<Marker> markers = getMarters(checkId, module);
  
          assertEquals(2, markers.size());
  
          String uriToProblem = EcoreUtil.getURI(variables.get(0)).toString();
          Marker marker = markers.get(0);
          assertEquals(Integer.valueOf(4), marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE));
          assertEquals(uriToProblem, marker.getExtraInfo().get(StandardExtraInfo.TEXT_URI_TO_PROBLEM));
  
          marker = markers.get(1);
          assertEquals(Integer.valueOf(22), marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE));
      }
  
      /**
       * Test of {@link DocCommentFieldTypeCheck} that each field in documentation comment has defined type.
       *
       * @throws Exception the exception
       */
      @Test
      public void testDocCommentFieldTypeCheck() throws Exception
      {
  
          String checkId = "doc-comment-field-type-strict";
  
          Module module = updateAndGetModule(checkId);
  
          List<Method> methods = module.allMethods();
          assertEquals(2, methods.size());
  
          List<Marker> markers = getMarters(checkId, module);
  
          assertEquals(1, markers.size());
  
          String uriToProblem = EcoreUtil.getURI(methods.get(0)).toString();
  
          Marker marker = markers.get(0);
  
          assertEquals(Integer.valueOf(5), marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE));
          assertEquals(uriToProblem, marker.getExtraInfo().get(StandardExtraInfo.TEXT_URI_TO_PROBLEM));
  
      }
  
      /**
       * Test of {@link FunctionReturnTypeCheck} that function has returning type.
       *
       * @throws Exception the exception
       */
      @Test
      public void testFunctionReturnTypeCheck() throws Exception
      {
  
          String checkId = "function-return-value-type";
  
          Module module = updateAndGetModule(checkId);
  
          List<Method> methods = module.allMethods();
          assertEquals(3, methods.size());
  
          List<Marker> markers = getMarters(checkId, module);
          assertEquals(1, markers.size());
  
          String uriToProblem = EcoreUtil.getURI(methods.get(0)).toString();
  
          Marker marker = markers.get(0);
          assertEquals(Integer.valueOf(3), marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE));
          assertEquals(uriToProblem, marker.getExtraInfo().get(StandardExtraInfo.TEXT_URI_TO_PROBLEM));
  
      }
  
      /**
       * Test of {@link MethodParamTypeCheck} that each method's parameter has defined or computed type.
       *
       * @throws Exception the exception
       */
      @Test
      public void testMethodParamTypeCheckk() throws Exception
      {
  
          String checkId = "method-param-value-type";
  
          Module module = updateAndGetModule(checkId);
  
          List<Method> methods = module.allMethods();
          assertEquals(2, methods.size());
  
          List<Marker> markers = getMarters(checkId, module);
          assertEquals(1, markers.size());
  
          String uriToProblem = EcoreUtil.getURI(methods.get(0).getFormalParams().get(0)).toString();
  
          Marker marker = markers.get(0);
          assertEquals(Integer.valueOf(3), marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE));
          assertEquals(uriToProblem, marker.getExtraInfo().get(StandardExtraInfo.TEXT_URI_TO_PROBLEM));
      }
  
      /**
       * Test of {@link DynamicFeatureAccessMethodNotFoundCheck} that dynamic method exist in the object.
       *
       * @throws Exception the exception
       */
      @Test
      public void testDynamicFeatureAccessMethodNotFoundCheck() throws Exception
      {
  
          String checkId = "dynamic-access-method-not-found";
  
          Module module = updateAndGetModule(checkId);
  
          List<DynamicFeatureAccess> dynamicMethods = EcoreUtil2.eAllOfType(module, DynamicFeatureAccess.class);
          assertEquals(2, dynamicMethods.size());
  
          List<Marker> markers = getMarters(checkId, module);
          assertEquals(1, markers.size());
  
          String uriToProblem = EcoreUtil.getURI(dynamicMethods.get(0)).toString();
  
          Marker marker = markers.get(0);
          assertEquals(Integer.valueOf(5), marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE));
          assertEquals(uriToProblem, marker.getExtraInfo().get(StandardExtraInfo.TEXT_URI_TO_PROBLEM));
  
      }
  
      /**
       * Test of {@link DynamicFeatureAccessTypeCheck} that dynamic property exist and has return type.
       *
       * @throws Exception the exception
       */
      @Test
      public void testDynamicFeatureAccessTypeCheck() throws Exception
      {
  
          String checkId = "property-return-type";
  
          Module module = updateAndGetModule(checkId);
  
          List<DynamicFeatureAccess> dynamicProperties = EcoreUtil2.eAllOfType(module, DynamicFeatureAccess.class);
          assertEquals(2, dynamicProperties.size());
  
          List<Marker> markers = getMarters(checkId, module);
          assertEquals(1, markers.size());
  
          String uriToProblem = EcoreUtil.getURI(dynamicProperties.get(0)).toString();
  
          Marker marker = markers.get(0);
          assertEquals(Integer.valueOf(5), marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE));
          assertEquals(uriToProblem, marker.getExtraInfo().get(StandardExtraInfo.TEXT_URI_TO_PROBLEM));
      }
  
      /**
       * Test of {@link SimpleStatementTypeCheck} that the statement change type of existing object type.
       *
       * @throws Exception the exception
       */
      @Test
      public void testSimpleStatementTypeCheck() throws Exception
      {
  
          String checkId = "statement-type-change";
  
          Module module = updateAndGetModule(checkId);
  
          List<SimpleStatement> statements = EcoreUtil2.eAllOfType(module, SimpleStatement.class);
          assertEquals(2, statements.size());
  
          List<Marker> markers = getMarters(checkId, module);
          assertEquals(1, markers.size());
  
          String uriToProblem = EcoreUtil.getURI(statements.get(0)).toString();
  
          Marker marker = markers.get(0);
          assertEquals(Integer.valueOf(6), marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE));
          assertEquals(uriToProblem, marker.getExtraInfo().get(StandardExtraInfo.TEXT_URI_TO_PROBLEM));
  
      }
  
      /**
       * Test of {@link SimpleStatementTypeCheck} that the statement change type of existing object type.
       * Should respect in-line documentation comment with types
       *
       * @throws Exception the exception
       */
      @Test
      public void testSimpleStatementTypeCheckWithDocComment() throws Exception
      {
  
          String checkId = "statement-type-change";
          String resourceName = "statement-type-change-with-doc-comment";
  
          Module module = updateAndGetModule(resourceName);
  
          List<Marker> markers = getMarters(checkId, module);
          assertEquals(1, markers.size());
  
          Marker marker = markers.get(0);
          assertEquals(Integer.valueOf(6), marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE));
  
      }
  
      /**
       * Test of {@link SimpleStatementTypeCheck} that the statement change type of existing object type.
       * Should correctly intersects with {@code CommonModule} type
       *
       * @throws Exception the exception
       */
      @Test
      public void testSimpleStatementTypeCheckCommonModule() throws Exception
      {
  
          String checkId = "statement-type-change";
          String resourceName = "statement-type-change-common-module";
  
          Module module = updateAndGetModule(resourceName);
  
          List<Marker> markers = getMarters(checkId, module);
          assertEquals(1, markers.size());
  
          Marker marker = markers.get(0);
          assertEquals(Integer.valueOf(6), marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE));
  
      }
  
      /**
       * Test of {@link FunctionCtorReturnSectionCheck} that the statement change type of existing object type.
       *
       * @throws Exception the exception
       */
      @Test
      public void testFunctionCtorReturnSectionCheck() throws Exception
      {
  
          String checkId = "constructor-function-return-section";
  
          Module module = updateAndGetModule(checkId);
  
          List<Function> functions = EcoreUtil2.eAllOfType(module, Function.class);
          assertEquals(5, functions.size());
  
          List<Marker> markers = getMarters(checkId, module);
  
          assertEquals(3, markers.size());
          List<Integer> errorLines = markers.stream()
              .map(marker -> marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE))
              .map(Integer.class::cast)
              .sorted()
              .collect(Collectors.toList());
          assertEquals(List.of(9, 9, 29), errorLines);
      }
  
      /**
       * Test of {@link InvocationParamIntersectionCheck} that invokable method parameter type intersects
       * with caller type.
       *
       * @throws Exception the exception
       */
      @Test
      public void testInvocationParamIntersectionCheck() throws Exception
      {
  
          String checkId = "invocation-parameter-type-intersect";
  
          Module module = updateAndGetModule(checkId);
  
          List<StaticFeatureAccess> statements = EcoreUtil2.eAllOfType(module, StaticFeatureAccess.class);
          assertEquals(6, statements.size());
  
          List<Marker> markers = getMarters(checkId, module);
  
          assertEquals(1, markers.size());
  
          String uriToProblem = EcoreUtil.getURI(statements.get(2)).toString();
  
          Marker marker = markers.get(0);
          assertEquals(Integer.valueOf(5), marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE));
          assertEquals(uriToProblem, marker.getExtraInfo().get(StandardExtraInfo.TEXT_URI_TO_PROBLEM));
  
      }
  
      /**
       * Test of {@link InvocationParamIntersectionCheck} that invokable method parameter type intersects
       * with caller type for collections with typed items.
       *
       * @throws Exception the exception
       */
      @Test
      public void testInvocationParamIntersectionCollectionItemCheck() throws Exception
      {
  
          String checkId = "invocation-parameter-type-intersect";
          String resouceName = "invocation-parameter-type-intersect-collection-item";
  
          Module module = updateAndGetModule(resouceName);
  
          List<Marker> markers = getMarters(checkId, module);
  
          assertEquals(3, markers.size());
          List<Integer> errorLines = markers.stream()
              .map(marker -> marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE))
              .map(Integer.class::cast)
              .sorted()
              .collect(Collectors.toList());
          assertEquals(List.of(10, 12, 13), errorLines);
      }
  
      /**
       * Test of {@link InvocationParamIntersectionCheck} that invokable method parameter type intersects
       * with method that has several ParamSets and should select correct ones.
       *
       * @throws Exception the exception
       */
      @Test
      public void testInvocationParamIntersectionSelectParamSet() throws Exception
      {
  
          String checkId = "invocation-parameter-type-intersect";
          String resouceName = "invocation-parameter-type-intersect-select-param-set";
  
          Module module = updateAndGetModule(resouceName);
  
          List<Marker> markers = getMarters(checkId, module);
  
          assertEquals(2, markers.size());
          List<Integer> errorLines = markers.stream()
              .map(marker -> marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE))
              .map(Integer.class::cast)
              .sorted()
              .collect(Collectors.toList());
          assertEquals(List.of(9, 17), errorLines);
      }
  
      /**
       * Test of {@link InvocationParamIntersectionCheck} that invokable method parameter type intersects
       * with caller type, and skip checking if method has default value parameters.
       *
       * @throws Exception the exception
       */
      @Test
      public void testInvocationParamIntersectionCheckWithDefault() throws Exception
      {
  
          String checkId = "invocation-parameter-type-intersect";
          String resouceName = "invocation-parameter-type-intersect-with-default";
  
          Module module = updateAndGetModule(resouceName);
  
          List<Marker> markers = getMarters(checkId, module);
  
          assertEquals(1, markers.size());
  
          Marker marker = markers.get(0);
          assertEquals(Integer.valueOf(5), marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE));
  
      }
  
      /**
       * Test of {@link InvocationParamIntersectionCheck} that invokable method parameter type intersects
       * with caller type that is local method with documentation comment.
       *
       * @throws Exception the exception
       */
      @Test
      public void testInvocationParamIntersectionCheckLocalDocComment() throws Exception
      {
  
          String checkId = "invocation-parameter-type-intersect";
          String resouceName = "invocation-parameter-type-intersect-local-doc-comment";
  
          Module module = updateAndGetModule(resouceName);
  
          List<Marker> markers = getMarters(checkId, module);
  
          assertEquals(1, markers.size());
  
          Marker marker = markers.get(0);
          assertEquals(Integer.valueOf(5), marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE));
  
      }
  
      /**
       * Test of {@link InvocationParamIntersectionCheck} that invokable method parameter type intersects
       * with value list item type.
       *
       * @throws Exception the exception
       */
      @Test
      public void testInvocationParamIntersectionCheckValueListItemType() throws Exception
      {
  
          String checkId = "invocation-parameter-type-intersect";
          String resouceName = "invocation-parameter-type-valuelist-item-type";
  
          Module module = updateAndGetModule(resouceName);
  
          List<Marker> markers = getMarters(checkId, module);
  
          assertEquals(1, markers.size());
  
          Marker marker = markers.get(0);
          assertEquals(Integer.valueOf(9), marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE));
      }
  
      /**
       * Test of {@link InvocationParamIntersectionCheck} that invokable method parameter type intersects
       * with value list item that has default undefined type.
       *
       * @throws Exception the exception
       */
      @Test
      public void testInvocationParamIntersectionCheckValueListUndefinedItemType() throws Exception
      {
  
          String checkId = "invocation-parameter-type-intersect";
          String resouceName = "invocation-parameter-type-valuelist-undefined-item-type";
  
          Module module = updateAndGetModule(resouceName);
  
          List<Marker> markers = getMarters(checkId, module);
  
          assertTrue(markers.isEmpty());
      }
  
      /**
       * Test of {@link TypedValueAddingToUntypedCollectionCheck} that typed value is adding
       * to untyped array.
       *
       * @throws Exception the exception
       */
      @Test
      public void testTypedValueAddingToUntypedCollectionCheck() throws Exception
      {
  
          String checkId = "typed-value-adding-to-untyped-collection";
          String resouceName = "typed-value-adding-to-untyped-array";
  
          Module module = updateAndGetModule(resouceName);
  
          List<DynamicFeatureAccess> statements = EcoreUtil2.eAllOfType(module, DynamicFeatureAccess.class);
          assertEquals(10, statements.size());
  
          List<Marker> markers = getMarters(checkId, module);
  
          assertEquals(3, markers.size());
          List<Integer> errorLines = markers.stream()
              .map(marker -> marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE))
              .map(Integer.class::cast)
              .sorted()
              .collect(Collectors.toList());
          assertEquals(List.of(19, 20, 21), errorLines);
      }
  
      /**
       * Test of {@link TypedValueAddingToUntypedCollectionCheck} that typed value is adding
       * to untyped value list.
       *
       * @throws Exception the exception
       */
      @Test
      public void testTypedValueAddingToUntypedValueListCheck() throws Exception
      {
  
          String checkId = "typed-value-adding-to-untyped-collection";
          String resouceName = "typed-value-adding-to-untyped-value-list";
  
          Module module = updateAndGetModule(resouceName);
  
          List<DynamicFeatureAccess> statements = EcoreUtil2.eAllOfType(module, DynamicFeatureAccess.class);
          assertEquals(8, statements.size());
  
          List<Marker> markers = getMarters(checkId, module);
  
          assertEquals(2, markers.size());
          List<Integer> errorLines = markers.stream()
              .map(marker -> marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE))
              .map(Integer.class::cast)
              .sorted()
              .collect(Collectors.toList());
          assertEquals(List.of(18, 19), errorLines);
      }
  
      /**
       * Test of {@link StructureKeyModificationCheck} that check replace existing key of external structure key,
       * delete key or clear structure with existing keys.
       *
       * @throws Exception the exception
       */
      @Test
      public void testStructureKeyModification() throws Exception
      {
  
          String checkId = "structure-key-modification";
          String resouceName = "structure-key-modification";
  
          Module module = updateAndGetModule(resouceName);
  
          List<Marker> markers = getMarters(checkId, module);
  
          assertEquals(10, markers.size());
          List<Integer> errorLines = markers.stream()
              .map(marker -> marker.getExtraInfo().get(StandardExtraInfo.TEXT_LINE))
              .map(Integer.class::cast)
              .sorted()
              .collect(Collectors.toList());
          assertEquals(List.of(7, 8, 9, 10, 36, 38, 39, 47, 49, 50), errorLines);
      }
  
      private IDtProject getProject()
      {
          return dtProject;
      }
  
      private List<Marker> getMarters(String checkId, Module module)
      {
          String id = module.eResource().getURI().toPlatformString(true);
          List<Marker> markers =
              new ArrayList<>(Arrays.asList(markerManager.getMarkers(getProject().getWorkspaceProject(), id)));
  
          markers.removeIf(m -> !checkId.equals(getCheckIdFromMarker(m, getProject())));
          return markers;
      }
  
      private Module updateAndGetModule(String resourceName) throws Exception
      {
          try (InputStream in = getClass().getResourceAsStream(FOLDER + resourceName + ".bsl"))
          {
              IFile file = getProject().getWorkspaceProject().getFile(COMMON_MODULE_FILE_NAME);
              file.setContents(in, true, true, new NullProgressMonitor());
          }
          testingWorkspace.waitForBuildCompletion();
          waitForDD(getProject());
          //after fixing the problem in EDT - delete it
          Thread.sleep(5000);
  
          IBmObject mdObject = getTopObjectByFqn(FQN, getProject());
          assertTrue(mdObject instanceof CommonModule);
          Module module = ((CommonModule)mdObject).getModule();
          assertNotNull(module);
          return module;
      }
  
  }
  