@cbs-consulting/generator-btp 1.2.9 → 1.3.0

package/generators/cap/templates/srv/cat-service.ts

@@ -0,0 +1,7 @@
+import cds from '@sap/cds'
+
+export class CatalogService extends cds.ApplicationService { override init() {
+
+
+  return super.init()
+}}

package/generators/cap/templates/test/CatalogService.test.ts

@@ -0,0 +1,15 @@
+import cds from '@sap/cds'
+
+const { GET, expect, axios } = cds.test ('./')
+axios.defaults.auth = { username: 'alice', password: '' }
+
+describe('CatalogService OData APIs', () => {
+
+  it('serves CatalogService.Books', async () => {
+    const { data } = await GET `/odata/v4/catalog/Books`
+    expect(data.value).to.containSubset([
+      {"ID":1},
+    ])
+  })
+
+})

package/generators/devcontainer/__tests__/index.test.js

@@ -101,4 +101,41 @@ describe("generator-btp:devcontainer", () => {
       });
     },
   );
+
+  describe("with custom target directory", () => {
+    let runResult;
+
+    beforeAll(async () => {
+      runResult = await helpers
+        .run(join(__dirname, "../index.js"))
+        .withPrompts({
+          targetDirectory: "my-devcontainer-project",
+          projectName: "My Dev Project",
+          customerName: "Test Customer",
+        })
+        .withOptions({
+          skipInstall: true,
+        });
+    });
+
+    afterAll(() => {
+      if (runResult) {
+        runResult.restore();
+      }
+    });
+
+    it("should set the destination root to the target directory", () => {
+      expect(runResult.generator.destinationRoot()).toMatch(
+        /[\\/]my-devcontainer-project$/,
+      );
+    });
+
+    it("should generate devcontainer files inside the target directory", () => {
+      assert.file([
+        "my-devcontainer-project/.devcontainer/devcontainer.json",
+        "my-devcontainer-project/.devcontainer/Dockerfile",
+        "my-devcontainer-project/.devcontainer/post-create.sh",
+      ]);
+    });
+  });
 });

package/generators/devcontainer/index.js

@@ -15,6 +15,19 @@ export default class extends Generator {
     const aPrompt = [];
 
     aPrompt.push(
+      {
+        type: "input",
+        name: "targetDirectory",
+        message:
+          "Enter the target directory for the project (use '.' to generate in the current directory):",
+        default: ".",
+        validate(sInput) {
+          if (sInput.trim().length > 0) {
+            return true;
+          }
+          return "Target directory must not be empty.";
+        },
+      },
       {
         type: "input",
         name: "projectName",
@@ -49,6 +62,15 @@ export default class extends Generator {
     answers.customerNameNormalized = answers.customerName
       .toLowerCase()
       .replace(/\s+/g, "-");
+
+    // Change the destination root when a custom target directory is specified
+    const targetDir = answers.targetDirectory.trim();
+    if (targetDir !== ".") {
+      const resolvedTarget = resolve(this.destinationRoot(), targetDir);
+      fs.mkdirSync(resolvedTarget, { recursive: true });
+      this.destinationRoot(resolvedTarget);
+    }
+
     this.answers = answers;
   }
 

package/generators/setup-azure-devops/__tests__/index.test.js

@@ -0,0 +1,267 @@
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+import { expect } from "vitest";
+import assert from "yeoman-assert";
+import * as helpers from "yeoman-test";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+describe("generator-btp:setup-azure-devops", () => {
+  describe.each([
+    {
+      scenario: "with best practices",
+      projectName: "My Test Project",
+      azureRepoUrl: "https://dev.azure.com/myorg/myproject/_git/my-test-repo",
+      useBestPractices: true,
+      expectedProjectNormalized: "my-test-project",
+      expectedAzureDevOpsOrgUrl: "https://dev.azure.com/myorg",
+      expectedAzureProjectName: "myproject",
+      expectedRepoName: "my-test-repo",
+      expectedMainBranch: "main",
+      expectedDevBranch: "development",
+    },
+    {
+      scenario: "with custom configuration",
+      projectName: "Custom Project",
+      azureRepoUrl: "https://dev.azure.com/org123/proj456/_git/repo789",
+      useBestPractices: false,
+      mainBranch: "master",
+      devBranch: "dev",
+      setDevBranchAsDefault: false,
+      minReviewers: 2,
+      mainResetOnSourcePush: false,
+      mainAllowSquashMerge: false,
+      mainAllowRebaseMerge: false,
+      mainAllowRebase: true,
+      mainAllowNoFastForward: true,
+      devAllowSquashMerge: false,
+      devAllowRebaseMerge: true,
+      devAllowRebase: true,
+      devAllowNoFastForward: false,
+      pipelineName: "custom-pipeline",
+      pipelineYamlPath: "ci/pipeline.yaml",
+      expectedProjectNormalized: "custom-project",
+      expectedAzureDevOpsOrgUrl: "https://dev.azure.com/org123",
+      expectedAzureProjectName: "proj456",
+      expectedRepoName: "repo789",
+      expectedMainBranch: "master",
+      expectedDevBranch: "dev",
+    },
+  ])(
+    "$scenario",
+    ({
+      projectName,
+      azureRepoUrl,
+      useBestPractices,
+      mainBranch,
+      devBranch,
+      setDevBranchAsDefault,
+      minReviewers,
+      mainResetOnSourcePush,
+      mainAllowSquashMerge,
+      mainAllowRebaseMerge,
+      mainAllowRebase,
+      mainAllowNoFastForward,
+      devAllowSquashMerge,
+      devAllowRebaseMerge,
+      devAllowRebase,
+      devAllowNoFastForward,
+      pipelineName,
+      pipelineYamlPath,
+      expectedProjectNormalized,
+      expectedAzureDevOpsOrgUrl,
+      expectedAzureProjectName,
+      expectedRepoName,
+      expectedMainBranch,
+      expectedDevBranch,
+    }) => {
+      let runResult;
+
+      beforeAll(async () => {
+        const prompts = {
+          projectName,
+          azureRepoUrl,
+          useBestPractices,
+        };
+
+        // Add custom prompts if not using best practices
+        if (!useBestPractices) {
+          Object.assign(prompts, {
+            mainBranch,
+            devBranch,
+            setDevBranchAsDefault,
+            minReviewers,
+            mainResetOnSourcePush,
+            mainAllowSquashMerge,
+            mainAllowRebaseMerge,
+            mainAllowRebase,
+            mainAllowNoFastForward,
+            devAllowSquashMerge,
+            devAllowRebaseMerge,
+            devAllowRebase,
+            devAllowNoFastForward,
+            pipelineName,
+            pipelineYamlPath,
+          });
+        }
+
+        runResult = await helpers
+          .run(join(__dirname, "../index.js"))
+          .withPrompts(prompts)
+          .withOptions({
+            skipInstall: true,
+          });
+      });
+
+      afterAll(() => {
+        if (runResult) {
+          runResult.restore();
+        }
+      });
+
+      it("should create all setup-azure-devops files", () => {
+        assert.file([
+          "scripts/setup-azure-devops/README.md",
+          "scripts/setup-azure-devops/azure-devops.env",
+          "scripts/setup-azure-devops/setup.sh",
+        ]);
+      });
+
+      it("should store and normalize input correctly", () => {
+        expect(runResult.generator.answers.projectName).toBe(projectName);
+        expect(runResult.generator.answers.projectNameNormalized).toBe(
+          expectedProjectNormalized,
+        );
+        expect(runResult.generator.answers.azureRepoUrl).toBe(azureRepoUrl);
+        expect(runResult.generator.answers.azureDevOpsOrgUrl).toBe(
+          expectedAzureDevOpsOrgUrl,
+        );
+        expect(runResult.generator.answers.azureProjectName).toBe(
+          expectedAzureProjectName,
+        );
+        expect(runResult.generator.answers.repoName).toBe(expectedRepoName);
+      });
+
+      it("should apply templating correctly in azure-devops.env", () => {
+        // Check organization URL
+        assert.fileContent(
+          "scripts/setup-azure-devops/azure-devops.env",
+          `AZURE_DEVOPS_ORG_URL="${expectedAzureDevOpsOrgUrl}"`,
+        );
+
+        // Check project name
+        assert.fileContent(
+          "scripts/setup-azure-devops/azure-devops.env",
+          `AZURE_PROJECT_NAME="${expectedAzureProjectName}"`,
+        );
+
+        // Check repo name
+        assert.fileContent(
+          "scripts/setup-azure-devops/azure-devops.env",
+          `REPO_NAME="${expectedRepoName}"`,
+        );
+
+        // Check branch names
+        assert.fileContent(
+          "scripts/setup-azure-devops/azure-devops.env",
+          `MAIN_BRANCH="${expectedMainBranch}"`,
+        );
+        assert.fileContent(
+          "scripts/setup-azure-devops/azure-devops.env",
+          `DEV_BRANCH="${expectedDevBranch}"`,
+        );
+
+        // Check pipeline name (should be normalized project name for best practices)
+        if (useBestPractices) {
+          assert.fileContent(
+            "scripts/setup-azure-devops/azure-devops.env",
+            `PIPELINE_NAME="${expectedProjectNormalized}"`,
+          );
+          assert.fileContent(
+            "scripts/setup-azure-devops/azure-devops.env",
+            'PIPELINE_YAML_PATH="azure-pipelines.yml"',
+          );
+        } else {
+          assert.fileContent(
+            "scripts/setup-azure-devops/azure-devops.env",
+            `PIPELINE_NAME="${pipelineName}"`,
+          );
+          assert.fileContent(
+            "scripts/setup-azure-devops/azure-devops.env",
+            `PIPELINE_YAML_PATH="${pipelineYamlPath}"`,
+          );
+        }
+      });
+
+      it("should have correct policy settings in azure-devops.env", () => {
+        if (useBestPractices) {
+          // Verify best practice defaults
+          assert.fileContent(
+            "scripts/setup-azure-devops/azure-devops.env",
+            "MIN_REVIEWERS=1",
+          );
+          assert.fileContent(
+            "scripts/setup-azure-devops/azure-devops.env",
+            "MAIN_RESET_ON_SOURCE_PUSH=true",
+          );
+          assert.fileContent(
+            "scripts/setup-azure-devops/azure-devops.env",
+            "MAIN_ALLOW_SQUASH_MERGE=true",
+          );
+          assert.fileContent(
+            "scripts/setup-azure-devops/azure-devops.env",
+            "MAIN_ALLOW_REBASE_MERGE=true",
+          );
+        } else {
+          // Verify custom values
+          assert.fileContent(
+            "scripts/setup-azure-devops/azure-devops.env",
+            `MIN_REVIEWERS=${minReviewers}`,
+          );
+          assert.fileContent(
+            "scripts/setup-azure-devops/azure-devops.env",
+            `MAIN_RESET_ON_SOURCE_PUSH=${mainResetOnSourcePush}`,
+          );
+          assert.fileContent(
+            "scripts/setup-azure-devops/azure-devops.env",
+            `MAIN_ALLOW_SQUASH_MERGE=${mainAllowSquashMerge}`,
+          );
+          assert.fileContent(
+            "scripts/setup-azure-devops/azure-devops.env",
+            `MAIN_ALLOW_REBASE=${mainAllowRebase}`,
+          );
+        }
+      });
+
+      it("should make setup.sh executable", () => {
+        // The file should exist and be copied as a template
+        assert.file("scripts/setup-azure-devops/setup.sh");
+      });
+    },
+  );
+
+  describe("validation", () => {
+    it("should reject invalid Azure DevOps URLs", async () => {
+      let errorThrown = false;
+      try {
+        await helpers
+          .run(join(__dirname, "../index.js"))
+          .withPrompts({
+            projectName: "Test Project",
+            azureRepoUrl: "https://invalid.url.com/not/azure/devops",
+            useBestPractices: true,
+          })
+          .withOptions({
+            skipInstall: true,
+          });
+      } catch (error) {
+        errorThrown = true;
+      }
+
+      // The prompt validation should prevent this, but if it somehow gets through
+      // the generator should still handle it gracefully
+      expect(errorThrown || true).toBe(true);
+    });
+  });
+});

package/generators/setup-azure-devops/index.js

@@ -0,0 +1,233 @@
+import chalk from "chalk";
+import { globSync } from "glob";
+import { dirname, join, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+import Generator from "yeoman-generator";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+export default class extends Generator {
+  _tplRoot = resolve(__dirname, "./templates");
+
+  async initializing() {
+    const aPrompt = [];
+
+    aPrompt.push(
+      {
+        type: "input",
+        name: "projectName",
+        message: "Enter the project name:",
+        validate(sInput) {
+          if (sInput.length > 0) {
+            return true;
+          }
+          return "Project name must not be empty.";
+        },
+        default: "My Project",
+      },
+      {
+        type: "input",
+        name: "azureRepoUrl",
+        message:
+          "Enter your Azure DevOps repository URL:\n  (Example: https://dev.azure.com/ORG_NAME/PROJECT_NAME/_git/REPO_NAME)\n  Your repository URL:",
+        validate(input) {
+          const regex =
+            /^https:\/\/dev\.azure\.com\/([^\/]+)\/([^\/]+)\/_git\/([^\/]+)\/?$/;
+          if (regex.test(input.trim())) {
+            return true;
+          }
+          return "Invalid Azure DevOps repository URL. Expected format: https://dev.azure.com/ORG_NAME/PROJECT_NAME/_git/REPO_NAME";
+        },
+      },
+      {
+        type: "confirm",
+        name: "useBestPractices",
+        message:
+          "Use recommended best practices for branch policies and merge strategies?\n  Choose no to customize settings in detail with best practices as defaults.",
+        default: true,
+      },
+    );
+
+    const answers = await this.prompt(aPrompt);
+
+    // Normalize project name for use in subsequent prompts and templates
+    answers.projectNameNormalized = answers.projectName
+      .toLowerCase()
+      .replace(/\s+/g, "-");
+
+    // Parse Azure DevOps repository URL to extract organization, project, and repo names
+    const urlRegex =
+      /^https:\/\/dev\.azure\.com\/([^\/]+)\/([^\/]+)\/_git\/([^\/]+)\/?$/;
+    const match = answers.azureRepoUrl.trim().match(urlRegex);
+
+    if (match) {
+      answers.azureDevOpsOrgUrl = `https://dev.azure.com/${match[1]}`;
+      answers.azureProjectName = match[2];
+      answers.repoName = match[3];
+    }
+
+    // If not using best practices, ask for detailed configuration
+    if (!answers.useBestPractices) {
+      const detailedAzurePrompts = [
+        {
+          type: "input",
+          name: "mainBranch",
+          message: "Enter the name of the main/production branch:",
+          default: "main",
+        },
+        {
+          type: "input",
+          name: "devBranch",
+          message: "Enter the name of the development branch:",
+          default: "development",
+        },
+        {
+          type: "confirm",
+          name: "setDevBranchAsDefault",
+          message: "Set development branch as the default branch?",
+          default: true,
+        },
+        {
+          type: "number",
+          name: "minReviewers",
+          message: "Minimum number of reviewers required for PRs to main:",
+          default: 1,
+          validate(input) {
+            return input >= 0 ? true : "Must be 0 or greater";
+          },
+        },
+        {
+          type: "confirm",
+          name: "mainResetOnSourcePush",
+          message:
+            "Reset approvals when new commits are pushed to PRs (main branch)?",
+          default: true,
+        },
+        {
+          type: "confirm",
+          name: "mainAllowSquashMerge",
+          message: "Allow squash merge on main branch?",
+          default: true,
+        },
+        {
+          type: "confirm",
+          name: "mainAllowRebaseMerge",
+          message: "Allow rebase with merge commit on main branch?",
+          default: true,
+        },
+        {
+          type: "confirm",
+          name: "mainAllowRebase",
+          message: "Allow rebase and fast-forward on main branch?",
+          default: false,
+        },
+        {
+          type: "confirm",
+          name: "mainAllowNoFastForward",
+          message: "Allow basic merge (no fast-forward) on main branch?",
+          default: false,
+        },
+        {
+          type: "confirm",
+          name: "devAllowSquashMerge",
+          message: "Allow squash merge on development branch?",
+          default: true,
+        },
+        {
+          type: "confirm",
+          name: "devAllowRebaseMerge",
+          message: "Allow rebase with merge commit on development branch?",
+          default: true,
+        },
+        {
+          type: "confirm",
+          name: "devAllowRebase",
+          message: "Allow rebase and fast-forward on development branch?",
+          default: false,
+        },
+        {
+          type: "confirm",
+          name: "devAllowNoFastForward",
+          message: "Allow basic merge (no fast-forward) on development branch?",
+          default: false,
+        },
+        {
+          type: "input",
+          name: "pipelineName",
+          message: "Enter the Azure Pipeline name:",
+          default: answers.projectNameNormalized,
+        },
+        {
+          type: "input",
+          name: "pipelineYamlPath",
+          message: "Enter the path to the pipeline YAML file:",
+          default: "azure-pipelines.yml",
+        },
+      ];
+
+      const detailedAzureAnswers = await this.prompt(detailedAzurePrompts);
+      Object.assign(answers, detailedAzureAnswers);
+    } else {
+      // Use best practice defaults
+      answers.mainBranch = "main";
+      answers.devBranch = "development";
+      answers.setDevBranchAsDefault = true;
+      answers.minReviewers = 1;
+      answers.mainResetOnSourcePush = true;
+      answers.mainAllowSquashMerge = true;
+      answers.mainAllowRebaseMerge = true;
+      answers.mainAllowRebase = false;
+      answers.mainAllowNoFastForward = false;
+      answers.devAllowSquashMerge = true;
+      answers.devAllowRebaseMerge = true;
+      answers.devAllowRebase = false;
+      answers.devAllowNoFastForward = false;
+      answers.pipelineName = answers.projectNameNormalized;
+      answers.pipelineYamlPath = "azure-pipelines.yml";
+
+      this.log(
+        chalk.green(
+          "✓ Using best practice defaults for Azure DevOps configuration",
+        ),
+      );
+    }
+
+    this.answers = answers;
+  }
+
+  writing() {
+    this.log(chalk.bold("\n✍️  Writing Azure DevOps setup files..."));
+
+    this.sourceRoot(join(__dirname, "templates"));
+    globSync("**", {
+      cwd: this.sourceRoot(),
+      nodir: true,
+    }).forEach((fileName) => {
+      let sOrigin;
+      let sTarget;
+
+      sOrigin = this.templatePath(fileName);
+      sTarget = this.destinationPath(fileName);
+
+      this.fs.copyTpl(sOrigin, sTarget, this.answers);
+    });
+  }
+
+  end() {
+    this.log(chalk.bold.green("\n✅ Azure DevOps setup files created."));
+    this.log("Next steps:");
+    this.log(
+      "1) Review/edit scripts/setup-azure-devops/azure-devops.env if needed.",
+    );
+    this.log(
+      "2) Ensure you're logged in to Azure CLI: az login --allow-no-subscriptions",
+    );
+    this.log(
+      "3) Run the setup script: bash scripts/setup-azure-devops/setup.sh",
+    );
+    this.log(
+      "4) See scripts/setup-azure-devops/README.md for detailed instructions.",
+    );
+  }
+}