From 02d91c6ccfbd5c7bfe25e397dfe80882a725b364 Mon Sep 17 00:00:00 2001
From: Aparna Ravindra <82894348+aparna-ravindra@users.noreply.github.com>
Date: Thu, 30 Sep 2021 10:19:20 +0530
Subject: [PATCH] checking for allowed category in validate-data script (#1131)

* checking for allowed category

* Update index.ts
---
 ci/properties/super-linter.properties.json |  2 +-
 script/validate-data/index.ts              | 13 ++++++++-----
 script/validate-data/settings.json         |  6 ++++++
 3 files changed, 15 insertions(+), 6 deletions(-)

diff --git a/ci/properties/super-linter.properties.json b/ci/properties/super-linter.properties.json
index e070300..0be52e1 100644
--- a/ci/properties/super-linter.properties.json
+++ b/ci/properties/super-linter.properties.json
@@ -2,5 +2,5 @@
   "name": "Super Linter - Run Linters for several languages",
   "description": "Run linters for several languages on your code base for changed files",
   "iconName": "octicon check-circle",
-  "categories": ["code-quality", "code-review"]
+  "categories": ["Continuous integration", "code-quality", "code-review"]
 }
diff --git a/script/validate-data/index.ts b/script/validate-data/index.ts
index 84518d7..7dce3d1 100755
--- a/script/validate-data/index.ts
+++ b/script/validate-data/index.ts
@@ -40,7 +40,7 @@ const propertiesSchema = {
   }
 }
 
-async function checkWorkflows(folders: string[]): Promise<WorkflowWithErrors[]> {
+async function checkWorkflows(folders: string[], allowed_categories: string[]): Promise<WorkflowWithErrors[]> {
   const result: WorkflowWithErrors[] = []
   const workflow_template_names = new Set()
   for (const folder of folders) {
@@ -55,7 +55,7 @@ async function checkWorkflows(folders: string[]): Promise<WorkflowWithErrors[]>
         const workflowFilePath = join(folder, e.name);
         const propertiesFilePath = join(folder, "properties", `${fileType}.properties.json`)
 
-        const workflowWithErrors = await checkWorkflow(workflowFilePath, propertiesFilePath);
+        const workflowWithErrors = await checkWorkflow(workflowFilePath, propertiesFilePath, allowed_categories);
         if(workflowWithErrors.name && workflow_template_names.size == workflow_template_names.add(workflowWithErrors.name).size) {
           workflowWithErrors.errors.push(`Workflow template name "${workflowWithErrors.name}" already exists`) 
         }
@@ -69,13 +69,12 @@ async function checkWorkflows(folders: string[]): Promise<WorkflowWithErrors[]>
   return result;
 }
 
-async function checkWorkflow(workflowPath: string, propertiesPath: string): Promise<WorkflowWithErrors> {
+async function checkWorkflow(workflowPath: string, propertiesPath: string, allowed_categories: string[]): Promise<WorkflowWithErrors> {
   let workflowErrors: WorkflowWithErrors = {
     id: workflowPath,
     name: null,
     errors: []
   }
-
   try {
     const workflowFileContent = await fs.readFile(workflowPath, "utf8");
     safeLoad(workflowFileContent); // Validate yaml parses without error
@@ -105,6 +104,10 @@ async function checkWorkflow(workflowPath: string, propertiesPath: string): Prom
       }
       
     }
+    if (!workflowPath.endsWith("blank.yml") && (!properties.categories || 
+      !properties.categories.some(category => allowed_categories.some(ac => ac.toLowerCase() == category.toLowerCase())))) {
+      workflowErrors.errors.push(`Workflow does not contain at least one allowed category - ${allowed_categories}`)
+    }
   } catch (e) {
     workflowErrors.errors.push(e.toString())
   }
@@ -115,7 +118,7 @@ async function checkWorkflow(workflowPath: string, propertiesPath: string): Prom
   try {
     const settings = require("./settings.json");
     const erroredWorkflows = await checkWorkflows(
-      settings.folders
+      settings.folders, settings.allowed_categories
     )
 
     if (erroredWorkflows.length > 0) {
diff --git a/script/validate-data/settings.json b/script/validate-data/settings.json
index 01092cc..ce89e36 100644
--- a/script/validate-data/settings.json
+++ b/script/validate-data/settings.json
@@ -4,5 +4,11 @@
     "../../automation",
     "../../deployments",
     "../../code-scanning"
+  ],
+  "allowed_categories" : [
+    "Continuous integration",
+    "Deployment",
+    "Code Scanning",
+    "Automation"
   ]
 }
\ No newline at end of file