Spk setup (#349)

* initial work

* disable the spk setup command because it is not ready

Co-authored-by: Samiya Akhtar <samiyaakhtar7@gmail.com>

Author: dennisseah

src/commands/init.test.ts

@@ -13,12 +13,8 @@ import {
   execute,
   getConfig,
   handleInteractiveMode,
-  ORG_NAME_VIOLATION,
   prompt,
-  validateAccessToken,
-  validateOrgName,
-  validatePersonalAccessToken,
-  validateProjectName
+  validatePersonalAccessToken
 } from "./init";
 import * as init from "./init";
 
@@ -107,72 +103,6 @@ describe("Test execute function", () => {
   });
 });
 
-describe("test validateOrgName function", () => {
-  it("empty value and value with space", () => {
-    expect(validateOrgName("")).toBe("Must enter an organization");
-    expect(validateOrgName(" ")).toBe("Must enter an organization");
-  });
-  it("invalid value", () => {
-    expect(validateOrgName("-abc")).toBe(ORG_NAME_VIOLATION);
-    expect(validateOrgName(".abc")).toBe(ORG_NAME_VIOLATION);
-    expect(validateOrgName("abc.")).toBe(ORG_NAME_VIOLATION);
-    expect(validateOrgName("a b")).toBe(ORG_NAME_VIOLATION);
-  });
-  it("valid value", () => {
-    expect(validateOrgName("hello")).toBe(true);
-    expect(validateOrgName("1Microsoft")).toBe(true);
-    expect(validateOrgName("Microsoft#1")).toBe(true);
-  });
-});
-
-describe("test validateProjectName function", () => {
-  it("empty value and value with space", () => {
-    expect(validateProjectName("")).toBe("Must enter a project name");
-    expect(validateProjectName(" ")).toBe("Must enter a project name");
-  });
-  it("space in value", () => {
-    expect(validateProjectName("a b")).toBe(
-      "Project name cannot contains spaces"
-    );
-  });
-  it("value over 64 chars long", () => {
-    expect(validateProjectName("a".repeat(65))).toBe(
-      "Project name cannot be longer than 64 characters"
-    );
-  });
-  it("invalid value", () => {
-    expect(validateProjectName("_abc")).toBe(
-      "Project name cannot begin with an underscore"
-    );
-    expect(validateProjectName(".abc")).toBe(
-      "Project name cannot begin or end with a period"
-    );
-    expect(validateProjectName("abc.")).toBe(
-      "Project name cannot begin or end with a period"
-    );
-    expect(validateProjectName(".abc.")).toBe(
-      "Project name cannot begin or end with a period"
-    );
-    expect(validateProjectName("a*b")).toBe(
-      `Project name can't contain special characters, such as / : \ ~ & % ; @ ' " ? < > | # $ * } { , + = [ ]`
-    );
-  });
-  it("valid value", () => {
-    expect(validateProjectName("BedrockSPK")).toBe(true);
-  });
-});
-
-describe("test validateAccessToken function", () => {
-  it("empty value", () => {
-    expect(validateAccessToken("")).toBe(
-      "Must enter a personal access token with read/write/manage permissions"
-    );
-  });
-  it("validate value", () => {
-    expect(validateAccessToken("mysecretshhhh")).toBe(true);
-  });
-});
-
 describe("test getConfig function", () => {
   it("with configuration file", () => {
     const mockedValues = {

src/commands/init.ts

@@ -11,7 +11,12 @@ import {
 } from "../config";
 import { build as buildCmd, exit as exitCmd } from "../lib/commandBuilder";
 import { deepClone } from "../lib/util";
-import { hasValue } from "../lib/validator";
+import {
+  hasValue,
+  validateAccessToken,
+  validateOrgName,
+  validateProjectName
+} from "../lib/validator";
 import { logger } from "../logger";
 import { IConfigYaml } from "../types";
 import decorator from "./init.decorator.json";
@@ -27,9 +32,6 @@ interface IAnswer {
   azdo_pat: string;
 }
 
-export const ORG_NAME_VIOLATION =
-  "Organization names must start with a letter or number, followed by letters, numbers or hyphens, and must end with a letter or number.";
-
 /**
  * Handles the case where command is loading a file.
  *
@@ -41,91 +43,6 @@ export const handleFileConfig = (file: string) => {
   logger.info("Successfully initialized the spk tool!");
 };
 
-/**
- * Returns true if organization name is proper.
- *
- * @param value Organization Name
- */
-export const validateOrgName = (value: string): string | boolean => {
-  if (!hasValue(value.trim())) {
-    return "Must enter an organization";
-  }
-  const pass = value.match(
-    /^[0-9a-zA-Z][^\s]*[0-9a-zA-Z]$/ // No Spaces
-  );
-  if (pass) {
-    return true;
-  }
-  return ORG_NAME_VIOLATION;
-};
-
-/**
- * Returns true if project name is proper.
- *
- * @param value Project Name
- */
-export const validateProjectName = (value: string): string | boolean => {
-  if (!hasValue(value)) {
-    return "Must enter a project name";
-  }
-  if (value.indexOf(" ") !== -1) {
-    return "Project name cannot contains spaces";
-  }
-  if (value.length > 64) {
-    return "Project name cannot be longer than 64 characters";
-  }
-  if (value.startsWith("_")) {
-    return "Project name cannot begin with an underscore";
-  }
-  if (value.startsWith(".") || value.endsWith(".")) {
-    return "Project name cannot begin or end with a period";
-  }
-
-  const invalidChars = [
-    "/",
-    ":",
-    "\\",
-    "~",
-    "&",
-    "%",
-    ";",
-    "@",
-    "'",
-    '"',
-    "?",
-    "<",
-    ">",
-    "|",
-    "#",
-    "$",
-    "*",
-    "}",
-    "{",
-    ",",
-    "+",
-    "=",
-    "[",
-    "]"
-  ];
-  if (invalidChars.some(x => value.indexOf(x) !== -1)) {
-    return `Project name can't contain special characters, such as / : \ ~ & % ; @ ' " ? < > | # $ * } { , + = [ ]`;
-  }
-
-  return true;
-};
-
-/**
- * Returns true if access token is not empty string
- *
- * @param value Access token
- */
-export const validateAccessToken = (value: string): string | boolean => {
-  if (!hasValue(value)) {
-    return "Must enter a personal access token with read/write/manage permissions";
-  }
-  return true;
-};
-
 /**
  * Prompts for questions
  *

src/commands/setup.decorator.json

@@ -0,0 +1,12 @@
+{
+  "command": "setup",
+  "alias": "s",
+  "description": "An interactive command to setup resources in azure and azure dev-ops",
+  "disabled": true,
+  "options": [
+    {
+      "arg": "-f, --file <config-file-path>",
+      "description": "Path to the file that contains answers to the questions."
+    }
+  ]
+}

src/commands/setup.md

@@ -0,0 +1,31 @@
+## Description
+
+This command assists in creating resources in Azure DevOps so that you can get
+started with using Bedrock. It creates
+
+1. An Azure DevOps project.
+
+By Default, it runs in an interactive mode where you are prompted for answers
+for a few questions
+
+1. Azure DevOps Organization Name
+2. Azure DevOps Project Name, the project to be created.
+3. Azure DevOps Personal Access Token. The token needs to have these permissions
+   1. Read and write projects.
+
+It can also run in a non interactive mode by providing a file that contains
+answers to the above questions.
+
+```
+spk setup --file <file-name>
+```
+
+Content of this file is as follow
+
+```
+azdo_org_name=<Azure DevOps Organization Name>
+azdo_project_name=<Azure DevOps Project Name>
+azdo_pat=<Azure DevOps Personal Access Token>
+```
+
+azdo_project_name is optional and default value is `BedrockRocks`