refactor: modify manifests for PY templates, add CEAEnabled consume logic and add test case

packages/fx-core/src/component/generator/generator.ts

@@ -93,6 +93,7 @@ export class Generator {
         : "",
       NewProjectTypeName: process.env.TEAMSFX_NEW_PROJECT_TYPE_NAME ?? "TeamsApp",
       NewProjectTypeExt: process.env.TEAMSFX_NEW_PROJECT_TYPE_EXTENSION ?? "ttkproj",
+      CEAEnabled: featureFlagManager.getBooleanValue(FeatureFlags.CEAEnabled) ? "true" : "",
     };
   }
   @hooks([

packages/fx-core/src/component/generator/templates/templateReplaceMap.ts

@@ -71,5 +71,6 @@ export function getTemplateReplaceMap(inputs: Inputs): { [key: string]: string }
       : "",
     NewProjectTypeName: process.env.TEAMSFX_NEW_PROJECT_TYPE_NAME ?? "TeamsApp",
     NewProjectTypeExt: process.env.TEAMSFX_NEW_PROJECT_TYPE_EXTENSION ?? "ttkproj",
+    CEAEnabled: featureFlagManager.getBooleanValue(FeatureFlags.CEAEnabled) ? "true" : "",
   };
 }

packages/fx-core/tests/component/generator/generator.test.ts

@@ -1174,6 +1174,22 @@ describe("render template", () => {
         `${templateName}-${commonTemplateName}`
       );
     });
+
+    it("template variables when CEA enabled", async () => {
+      sandbox.stub(process, "env").value({ TEAMSFX_CEA_ENABLED: "true" });
+      const vars = newGeneratorFlag
+        ? getTemplateReplaceMap(inputs)
+        : Generator.getDefaultVariables("test");
+      assert.equal(vars.CEAEnabled, "true");
+    });
+
+    it("template variables when CEA disabled", async () => {
+      sandbox.stub(process, "env").value({ TEAMSFX_CEA_ENABLED: "false" });
+      const vars = newGeneratorFlag
+        ? getTemplateReplaceMap(inputs)
+        : Generator.getDefaultVariables("test");
+      assert.equal(vars.CEAEnabled, "");
+    });
   });
 });
 

templates/python/custom-copilot-assistant-assistants-api/appPackage/manifest.json.tpl

@@ -1,7 +1,14 @@
 {
+    {{#CEAEnabled}}
+    "$schema": " https://developer.microsoft.com/en-us/json-schemas/teams/vdevPreview/MicrosoftTeams.schema.json",
+    "manifestVersion": "devPreview",
+    "version": "1.0.0",
+    {{/CEAEnabled}}
+    {{^CEAEnabled}}
     "$schema": "https://developer.microsoft.com/en-us/json-schemas/teams/v1.17/MicrosoftTeams.schema.json",
     "manifestVersion": "1.17",
     "version": "1.0.0",
+    {{/CEAEnabled}}
     "id": "${{TEAMS_APP_ID}}",
     "developer": {
         "name": "Teams App, Inc.",
@@ -22,6 +29,16 @@
         "full": "full description for {{appName}}"
     },
     "accentColor": "#FFFFFF",
+    {{#CEAEnabled}}
+    "copilotAgents": {
+        "customEngineAgents": [
+            {
+                "type": "bot",
+                "id": "${{BOT_ID}}"
+            }
+        ]
+    },
+    {{/CEAEnabled}}
     "bots": [
         {
             "botId": "${{BOT_ID}}",

templates/python/custom-copilot-assistant-assistants-api/teamsapp.local.yml.tpl

@@ -39,11 +39,13 @@ provision:
       channels:
         - name: msteams
 
+  {{^CEAEnabled}}
   # Validate using manifest schema
   - uses: teamsApp/validateManifest
     with:
       # Path to manifest template
       manifestPath: ./appPackage/manifest.json
+  {{/CEAEnabled}}
 
   # Build Teams app package with latest env value
   - uses: teamsApp/zipAppPackage
@@ -52,11 +54,13 @@ provision:
       manifestPath: ./appPackage/manifest.json
       outputZipPath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
       outputFolder: ./appPackage/build
+  {{^CEAEnabled}}
   # Validate app package using validation rules
   - uses: teamsApp/validateAppPackage
     with:
       # Relative path to this file. This is the path for built zip file.
       appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+  {{/CEAEnabled}}
 
   # Apply the Teams app manifest to an existing Teams app in
   # Teams Developer Portal.

templates/python/custom-copilot-assistant-assistants-api/teamsapp.yml.tpl

@@ -57,23 +57,27 @@ provision:
       # will use bicep CLI in PATH if you remove this config.
       bicepCliVersion: v0.9.1
 
+  {{^CEAEnabled}}
   # Validate using manifest schema
   - uses: teamsApp/validateManifest
     with:
       # Path to manifest template
       manifestPath: ./appPackage/manifest.json
+  {{/CEAEnabled}}
   # Build Teams app package with latest env value
   - uses: teamsApp/zipAppPackage
     with:
       # Path to manifest template
       manifestPath: ./appPackage/manifest.json
       outputZipPath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
       outputFolder: ./appPackage/build
+  {{^CEAEnabled}}
   # Validate app package using validation rules
   - uses: teamsApp/validateAppPackage
     with:
       # Relative path to this file. This is the path for built zip file.
       appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+  {{/CEAEnabled}}
   # Apply the Teams app manifest to an existing Teams app in
   # Teams Developer Portal.
   # Will use the app id in manifest file to determine which Teams app to update.
@@ -100,23 +104,27 @@ deploy:
 
 # Triggered when 'teamsapp publish' is executed
 publish:
+  {{^CEAEnabled}}
   # Validate using manifest schema
   - uses: teamsApp/validateManifest
     with:
       # Path to manifest template
       manifestPath: ./appPackage/manifest.json
+  {{/CEAEnabled}}
   # Build Teams app package with latest env value
   - uses: teamsApp/zipAppPackage
     with:
       # Path to manifest template
       manifestPath: ./appPackage/manifest.json
       outputZipPath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
       outputFolder: ./appPackage/build
+  {{^CEAEnabled}}
   # Validate app package using validation rules
   - uses: teamsApp/validateAppPackage
     with:
       # Relative path to this file. This is the path for built zip file.
       appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+  {{/CEAEnabled}}
   # Apply the Teams app manifest to an existing Teams app in
   # Teams Developer Portal.
   # Will use the app id in manifest file to determine which Teams app to update.

templates/python/custom-copilot-assistant-new/appPackage/manifest.json.tpl

@@ -1,7 +1,14 @@
 {
+    {{#CEAEnabled}}
+    "$schema": " https://developer.microsoft.com/en-us/json-schemas/teams/vdevPreview/MicrosoftTeams.schema.json",
+    "manifestVersion": "devPreview",
+    "version": "1.0.0",
+    {{/CEAEnabled}}
+    {{^CEAEnabled}}
     "$schema": "https://developer.microsoft.com/en-us/json-schemas/teams/v1.17/MicrosoftTeams.schema.json",
     "manifestVersion": "1.17",
     "version": "1.0.0",
+    {{/CEAEnabled}}
     "id": "${{TEAMS_APP_ID}}",
     "developer": {
         "name": "Teams App, Inc.",
@@ -22,6 +29,16 @@
         "full": "full description for {{appName}}"
     },
     "accentColor": "#FFFFFF",
+    {{#CEAEnabled}}
+    "copilotAgents": {
+        "customEngineAgents": [
+            {
+                "type": "bot",
+                "id": "${{BOT_ID}}"
+            }
+        ]
+    },
+    {{/CEAEnabled}}
     "bots": [
         {
             "botId": "${{BOT_ID}}",

templates/python/custom-copilot-assistant-new/teamsapp.local.yml.tpl

@@ -39,11 +39,13 @@ provision:
       channels:
         - name: msteams
 
+  {{^CEAEnabled}}
   # Validate using manifest schema
   - uses: teamsApp/validateManifest
     with:
       # Path to manifest template
       manifestPath: ./appPackage/manifest.json
+  {{/CEAEnabled}}
 
   # Build Teams app package with latest env value
   - uses: teamsApp/zipAppPackage
@@ -52,11 +54,13 @@ provision:
       manifestPath: ./appPackage/manifest.json
       outputZipPath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
       outputFolder: ./appPackage/build
+  {{^CEAEnabled}}
   # Validate app package using validation rules
   - uses: teamsApp/validateAppPackage
     with:
       # Relative path to this file. This is the path for built zip file.
       appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+  {{/CEAEnabled}}
 
   # Apply the Teams app manifest to an existing Teams app in
   # Teams Developer Portal.

templates/python/custom-copilot-assistant-new/teamsapp.yml.tpl

@@ -57,23 +57,27 @@ provision:
       # will use bicep CLI in PATH if you remove this config.
       bicepCliVersion: v0.9.1
 
+  {{^CEAEnabled}}
   # Validate using manifest schema
   - uses: teamsApp/validateManifest
     with:
       # Path to manifest template
       manifestPath: ./appPackage/manifest.json
+  {{/CEAEnabled}}
   # Build Teams app package with latest env value
   - uses: teamsApp/zipAppPackage
     with:
       # Path to manifest template
       manifestPath: ./appPackage/manifest.json
       outputZipPath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
       outputFolder: ./appPackage/build
+  {{^CEAEnabled}}
   # Validate app package using validation rules
   - uses: teamsApp/validateAppPackage
     with:
       # Relative path to this file. This is the path for built zip file.
       appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+  {{/CEAEnabled}}
   # Apply the Teams app manifest to an existing Teams app in
   # Teams Developer Portal.
   # Will use the app id in manifest file to determine which Teams app to update.
@@ -100,23 +104,27 @@ deploy:
 
 # Triggered when 'teamsapp publish' is executed
 publish:
+  {{^CEAEnabled}}
   # Validate using manifest schema
   - uses: teamsApp/validateManifest
     with:
       # Path to manifest template
       manifestPath: ./appPackage/manifest.json
+  {{/CEAEnabled}}
   # Build Teams app package with latest env value
   - uses: teamsApp/zipAppPackage
     with:
       # Path to manifest template
       manifestPath: ./appPackage/manifest.json
       outputZipPath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
       outputFolder: ./appPackage/build
+  {{^CEAEnabled}}
   # Validate app package using validation rules
   - uses: teamsApp/validateAppPackage
     with:
       # Relative path to this file. This is the path for built zip file.
       appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+  {{/CEAEnabled}}
   # Apply the Teams app manifest to an existing Teams app in
   # Teams Developer Portal.
   # Will use the app id in manifest file to determine which Teams app to update.

templates/python/custom-copilot-basic/appPackage/manifest.json.tpl

@@ -1,7 +1,14 @@
 {
+    {{#CEAEnabled}}
+    "$schema": " https://developer.microsoft.com/en-us/json-schemas/teams/vdevPreview/MicrosoftTeams.schema.json",
+    "manifestVersion": "devPreview",
+    "version": "1.0.0",
+    {{/CEAEnabled}}
+    {{^CEAEnabled}}
     "$schema": "https://developer.microsoft.com/en-us/json-schemas/teams/v1.17/MicrosoftTeams.schema.json",
     "manifestVersion": "1.17",
     "version": "1.0.0",
+    {{/CEAEnabled}}
     "id": "${{TEAMS_APP_ID}}",
     "developer": {
         "name": "Teams App, Inc.",
@@ -22,6 +29,16 @@
         "full": "full description for {{appName}}"
     },
     "accentColor": "#FFFFFF",
+    {{#CEAEnabled}}
+    "copilotAgents": {
+        "customEngineAgents": [
+            {
+                "type": "bot",
+                "id": "${{BOT_ID}}"
+            }
+        ]
+    },
+    {{/CEAEnabled}}
     "bots": [
         {
             "botId": "${{BOT_ID}}",

templates/python/custom-copilot-basic/teamsapp.local.yml.tpl

@@ -39,11 +39,13 @@ provision:
       channels:
         - name: msteams
 
+  {{^CEAEnabled}}
   # Validate using manifest schema
   - uses: teamsApp/validateManifest
     with:
       # Path to manifest template
       manifestPath: ./appPackage/manifest.json
+  {{/CEAEnabled}}
 
   # Build Teams app package with latest env value
   - uses: teamsApp/zipAppPackage
@@ -52,11 +54,13 @@ provision:
       manifestPath: ./appPackage/manifest.json
       outputZipPath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
       outputFolder: ./appPackage/build
+  {{^CEAEnabled}}
   # Validate app package using validation rules
   - uses: teamsApp/validateAppPackage
     with:
       # Relative path to this file. This is the path for built zip file.
       appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+  {{/CEAEnabled}}
 
   # Apply the Teams app manifest to an existing Teams app in
   # Teams Developer Portal.

templates/python/custom-copilot-basic/teamsapp.yml.tpl

@@ -57,23 +57,27 @@ provision:
       # will use bicep CLI in PATH if you remove this config.
       bicepCliVersion: v0.9.1
 
+  {{^CEAEnabled}}
   # Validate using manifest schema
   - uses: teamsApp/validateManifest
     with:
       # Path to manifest template
       manifestPath: ./appPackage/manifest.json
+  {{/CEAEnabled}}
   # Build Teams app package with latest env value
   - uses: teamsApp/zipAppPackage
     with:
       # Path to manifest template
       manifestPath: ./appPackage/manifest.json
       outputZipPath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
       outputFolder: ./appPackage/build
+  {{^CEAEnabled}}
   # Validate app package using validation rules
   - uses: teamsApp/validateAppPackage
     with:
       # Relative path to this file. This is the path for built zip file.
       appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+  {{/CEAEnabled}}
   # Apply the Teams app manifest to an existing Teams app in
   # Teams Developer Portal.
   # Will use the app id in manifest file to determine which Teams app to update.
@@ -100,23 +104,27 @@ deploy:
 
 # Triggered when 'teamsapp publish' is executed
 publish:
+  {{^CEAEnabled}}
   # Validate using manifest schema
   - uses: teamsApp/validateManifest
     with:
       # Path to manifest template
       manifestPath: ./appPackage/manifest.json
+  {{/CEAEnabled}}
   # Build Teams app package with latest env value
   - uses: teamsApp/zipAppPackage
     with:
       # Path to manifest template
       manifestPath: ./appPackage/manifest.json
       outputZipPath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
       outputFolder: ./appPackage/build
+  {{^CEAEnabled}}
   # Validate app package using validation rules
   - uses: teamsApp/validateAppPackage
     with:
       # Relative path to this file. This is the path for built zip file.
       appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
+  {{/CEAEnabled}}
   # Apply the Teams app manifest to an existing Teams app in
   # Teams Developer Portal.
   # Will use the app id in manifest file to determine which Teams app to update.