added test coverage

Author: VitaliyBoyko

resources/magento2/inspection.properties

@@ -40,4 +40,4 @@ inspection.warning.method.does.not.exist=The method "{0}" does not exist in the
 inspection.warning.method.should.have.public.access=The method "{0}" should have public access
 inspection.warning.method.should.have.public.access.fix=Change the method access
 inspection.displayName.ModuleScopeInspection=Module Configuration Scope Inspection
-inspection.config.wrong.area = The config file area is wrong. Please check the spelling of the parent directory, it should be equal to the following: adminhtml, frontend, crontab, webapi_rest, webapi_soap, graphql.
+inspection.config.wrong.area = The area of this config file is wrong. Please check the spelling of the parent directory, it should be equal to one of the following: adminhtml, frontend, crontab, webapi_rest, webapi_soap, graphql.

src/com/magento/idea/magento2plugin/inspections/xml/ModuleScopeInspection.java

@@ -7,19 +7,21 @@
 
 import com.intellij.codeInspection.ProblemHighlightType;
 import com.intellij.codeInspection.ProblemsHolder;
+import com.intellij.codeInspection.XmlSuppressableInspectionTool;
 import com.intellij.openapi.vfs.VirtualFile;
-import com.intellij.psi.*;
+import com.intellij.psi.PsiDirectory;
+import com.intellij.psi.PsiElementVisitor;
+import com.intellij.psi.PsiFile;
+import com.intellij.psi.XmlElementVisitor;
 import com.magento.idea.magento2plugin.bundles.InspectionBundle;
-import com.magento.idea.magento2plugin.magento.files.ModuleEventsXml;
 import com.magento.idea.magento2plugin.magento.packages.Areas;
-import com.jetbrains.php.lang.inspections.PhpInspection;
 import com.magento.idea.magento2plugin.magento.packages.ComponentType;
 import com.magento.idea.magento2plugin.magento.packages.Package;
 import com.magento.idea.magento2plugin.util.magento.GetMagentoModuleUtil;
 import org.jetbrains.annotations.NotNull;
 import java.util.*;
 
-public class ModuleScopeInspection extends PhpInspection {
+public class ModuleScopeInspection extends XmlSuppressableInspectionTool {
 
     @NotNull
     @SuppressWarnings({"PMD.AvoidInstantiatingObjectsInLoops", "PMD.CognitiveComplexity"})
@@ -34,10 +36,6 @@ public PsiElementVisitor buildVisitor(
 
             @Override
             public void visitFile(final @NotNull PsiFile file) {
-                if (!ModuleEventsXml.FILE_NAME.equals(file.getName())) {
-                    return;
-                }
-
                 final PsiDirectory targetDirectory = file.getParent();
                 if (targetDirectory == null) {
                     return;
@@ -61,7 +59,7 @@ public void visitFile(final @NotNull PsiFile file) {
 
                 final String directoryName = targetDirectory.getName();
                 final Areas area = Areas.getAreaByString(targetDirectory.getName());
-                if (area == null || directoryName.equals(Areas.base)) {
+                if (area == null || directoryName.equals(Areas.base.toString())) {
                     problemsHolder.registerProblem(
                             file,
                             inspectionBundle.message(

testData/inspections/xml/ModuleScopeInspection/correctArea/app/code/Test/TestModule/etc/adminhtml/di.xml

@@ -0,0 +1,8 @@
+<warning descr="The area of this config file is wrong. Please check the spelling of the parent directory, it should be equal to one of the following: adminhtml, frontend, crontab, webapi_rest, webapi_soap, graphql." />
+<?xml version="1.0"?>
+<!--
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->

testData/inspections/xml/ModuleScopeInspection/correctArea/app/code/Test/TestModule/registration.php

@@ -0,0 +1,5 @@
+<?php
+
+use Magento\Framework\Component\ComponentRegistrar;
+
+ComponentRegistrar::register(ComponentRegistrar::MODULE, 'Test_TestModule', __DIR__);

testData/inspections/xml/ModuleScopeInspection/incorrectArea/app/code/Test/TestModule/etc/adminhtmltypo/di.xml

@@ -0,0 +1,8 @@
+<warning descr="The area of this config file is wrong. Please check the spelling of the parent directory, it should be equal to one of the following: adminhtml, frontend, crontab, webapi_rest, webapi_soap, graphql." />
+<?xml version="1.0"?>
+<!--
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->

testData/inspections/xml/ModuleScopeInspection/incorrectArea/app/code/Test/TestModule/registration.php

@@ -0,0 +1,5 @@
+<?php
+
+use Magento\Framework\Component\ComponentRegistrar;
+
+ComponentRegistrar::register(ComponentRegistrar::MODULE, 'Test_TestModule', __DIR__);

tests/com/magento/idea/magento2plugin/inspections/xml/ModuleScopeInspectionTest.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.inspections.xml;
+
+public class ModuleScopeInspectionTest extends InspectionXmlFixtureTestCase {
+
+    private static final String WRONG_AREA =
+            "inspection.config.wrong.area";
+
+    @Override
+    public void setUp() throws Exception {
+        super.setUp();
+        myFixture.enableInspections(ModuleScopeInspection.class);
+    }
+
+    /**
+     * Inspection highlights warning if the area of a config file is wrong
+     */
+    public void testIncorrectArea() {
+        configureFixture("app/code/Test/TestModule/etc/adminhtmltypo/di.xml");
+
+        final String errorMessage =  inspectionBundle.message(
+                WRONG_AREA
+        );
+
+        assertHasHighlighting(errorMessage);
+    }
+
+    /**
+     * Inspection skips warning if the area is correct.
+     */
+    public void testCorrectArea() {
+        configureFixture("app/code/Test/TestModule/etc/adminhtml/di.xml");
+
+        final String errorMessage =  inspectionBundle.message(
+                WRONG_AREA
+
+        );
+
+        assertHasNoHighlighting(errorMessage);
+    }
+
+    private void configureFixture(String fixturePath) {
+        myFixture.copyFileToProject(getFixturePath("app/code/Test/TestModule/registration.php"));
+        myFixture.configureByFile(getFixturePath(fixturePath));
+    }
+}