Bitbake recipe view

__mocks__/vscode.ts

@@ -23,6 +23,8 @@ const languages = {
     onDidChangeActiveTextEditor: jest.fn(),
     showInformationMessage: jest.fn(),
     createWebviewPanel: jest.fn(),
+    registerTreeDataProvider: jest.fn(),
+    createTreeView: jest.fn(),
   };
 
   const workspace = {
@@ -105,6 +107,13 @@ const languages = {
     Default: 0,
   };
 
+  const TreeItem = jest.fn();
+  const TreeItemCollapsibleState = {
+    None: 0,
+    Collapsed: 1,
+    Expanded: 2,
+  };
+
   export = {
     ThemeColor,
     CodeLens,
@@ -131,4 +140,6 @@ const languages = {
     TestRunRequest,
     ViewColumn,
     QuickPickItemKind,
+    TreeItem,
+    TreeItemCollapsibleState
   };

client/package.json

@@ -143,6 +143,21 @@
           "message": 4
         }
       },
+      {
+        "name": "bitbake-UnableToParse",
+        "source": "bitbake",
+        "owner": "bitbake",
+        "fileLocation": [
+          "autoDetect",
+          "${cwd}"
+        ],
+        "pattern": {
+          "regexp": "^ERROR: (Unable to parse) (.+)$",
+          "file": 2,
+          "message": 1,
+          "kind": "File"
+        }
+      },
       {
         "name": "bitbake-Variable",
         "source": "bitbake",
@@ -194,17 +209,20 @@
       {
         "command": "bitbake.rescan-project",
         "title": "BitBake: Rescan Project",
-        "description": "This command rescans the bitbake project."
+        "description": "This command rescans the bitbake project.",
+        "icon": "$(refresh)"
       },
       {
         "command": "bitbake.build-recipe",
         "title": "BitBake: Build recipe",
-        "description": "Build a recipe or an image."
+        "description": "Build a recipe or an image.",
+        "icon": "$(gear)"
       },
       {
         "command": "bitbake.clean-recipe",
         "title": "BitBake: Clean recipe",
-        "description": "Clean a recipe or an image (bitbake -c clean)."
+        "description": "Clean a recipe or an image (bitbake -c clean).",
+        "icon": "$(exclude)"
       },
       {
         "command": "bitbake.run-task",
@@ -214,20 +232,39 @@
       {
         "command": "bitbake.drop-recipe",
         "title": "BitBake: Drop a recipe from the active workspace",
-        "description": "Stop watching or suggesting a recipe in bitbake commands."
+        "description": "Stop watching or suggesting a recipe in bitbake commands.",
+        "icon": "$(close)"
       },
       {
         "command": "bitbake.watch-recipe",
         "title": "BitBake: Add a recipe to the active workspace",
-        "description": "Start watching or suggesting a recipe in bitbake commands.",
-        "enablement": "false"
+        "description": "Start watching or suggesting a recipe in bitbake commands."
       },
       {
         "command": "bitbake.parse-recipes",
         "title": "BitBake: Parse all recipes",
         "description": "This command runs bitbake in parse-only mode."
       }
     ],
+    "viewsContainers": {
+      "activitybar": [
+        {
+          "id": "bitbakeView",
+          "title": "Bitbake",
+          "icon": "images/yocto-view-icon.svg"
+        }
+      ]
+    },
+    "views": {
+      "bitbakeView": [
+        {
+          "id": "bitbakeRecipes",
+          "name": "Recipes",
+          "contextualTitle": "Recipes Explorer",
+          "when": "resourceLangId == bitbake"
+        }
+      ]
+    },
     "submenus": [
       {
         "id": "bitbake/main",
@@ -238,15 +275,15 @@
       "bitbake/main": [
         {
           "command": "bitbake.clean-recipe",
-          "group": "bitbake_recipe"
+          "group": "bitbake_recipe@1"
         },
         {
           "command": "bitbake.build-recipe",
-          "group": "bitbake_recipe"
+          "group": "bitbake_recipe@0"
         },
         {
           "command": "bitbake.run-task",
-          "group": "bitbake_recipe"
+          "group": "bitbake_recipe@2"
         }
       ],
       "explorer/context": [
@@ -269,6 +306,50 @@
           "group": "bitbake",
           "when": "resourceLangId == bitbake"
         }
+      ],
+      "view/title": [
+        {
+          "command": "bitbake.rescan-project",
+          "group": "navigation@0",
+          "when": "view == bitbakeRecipes"
+        }
+      ],
+      "view/item/context": [
+        {
+          "command": "bitbake.clean-recipe",
+          "group": "bitbake_recipe@1",
+          "when": "view == bitbakeRecipeCtx"
+        },
+        {
+          "command": "bitbake.build-recipe",
+          "group": "bitbake_recipe@0",
+          "when": "viewItem == bitbakeRecipeCtx"
+        },
+        {
+          "command": "bitbake.run-task",
+          "group": "bitbake_recipe@2",
+          "when": "viewItem == bitbakeRecipeCtx"
+        },
+        {
+          "command": "bitbake.drop-recipe",
+          "group": "bitbake_recipe@3",
+          "when": "viewItem == bitbakeRecipeCtx"
+        },
+        {
+          "command": "bitbake.build-recipe",
+          "group": "inline@0",
+          "when": "viewItem == bitbakeRecipeCtx"
+        },
+        {
+          "command": "bitbake.clean-recipe",
+          "group": "inline@1",
+          "when": "viewItem == bitbakeRecipeCtx"
+        },
+        {
+          "command": "bitbake.drop-recipe",
+          "group": "inline@2",
+          "when": "viewItem == bitbakeRecipeCtx"
+        }
       ]
     }
   },

client/src/__tests__/unit-tests/ui/bitbake-recipes-view.test.ts

@@ -0,0 +1,71 @@
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) 2023 Savoir-faire Linux. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ * ------------------------------------------------------------------------------------------ */
+
+import * as vscode from 'vscode'
+import { type BitbakeRecipeTreeItem, BitbakeRecipesView } from '../../../ui/BitbakeRecipesView'
+import { BitbakeWorkspace } from '../../../ui/BitbakeWorkspace'
+import { BitBakeProjectScannerClient } from '../../../language/BitbakeProjectScannerClient'
+import { type LanguageClient } from 'vscode-languageclient/node'
+
+jest.mock('vscode')
+
+describe('BitbakeDriver Recipes View', () => {
+  it('should list recipes', (done) => {
+    const bitbakeWorkspace = new BitbakeWorkspace()
+    bitbakeWorkspace.addActiveRecipe('base-files')
+
+    const clientMock: LanguageClient = {
+      onNotification: jest.fn()
+    } as any
+    const contextMock: vscode.ExtensionContext = {
+      subscriptions: {
+        push: jest.fn()
+      }
+    } as any
+
+    const bitbakeProjectScannerClient = new BitBakeProjectScannerClient(clientMock)
+    bitbakeProjectScannerClient.bitbakeScanResult = {
+      recipes: [
+        {
+          name: 'base-files',
+          path: {
+            root: '/',
+            dir: '/home/user/yocto/poky/meta/recipes-core/base-files',
+            base: 'base-files_3.0.14',
+            ext: '.bb',
+            name: 'base-files'
+          },
+          appends: [
+            {
+              root: '/',
+              dir: '/home/user/yocto/poky/meta/recipes-core/base-files',
+              base: 'base-files_%',
+              ext: '.bbappend',
+              name: 'base-files'
+            }
+          ]
+        }
+      ],
+      includes: []
+    }
+
+    vscode.window.registerTreeDataProvider = jest.fn().mockImplementation(
+      async (viewId: string, treeDataProvider: vscode.TreeDataProvider<BitbakeRecipeTreeItem>): Promise<void> => {
+        const rootTreeItem = await treeDataProvider.getChildren(undefined)
+        expect(rootTreeItem).toBeDefined()
+        expect(rootTreeItem?.length).toStrictEqual(2)
+        const recipeItem = (rootTreeItem as BitbakeRecipeTreeItem[])[0]
+        expect(recipeItem.label).toStrictEqual('base-files')
+
+        const filesItems = await treeDataProvider.getChildren(recipeItem)
+        expect(filesItems).toBeDefined()
+        expect(filesItems?.length).toStrictEqual(2)
+        done()
+      })
+
+    const bitbakeRecipesView = new BitbakeRecipesView(bitbakeWorkspace, bitbakeProjectScannerClient)
+    bitbakeRecipesView.registerView(contextMock)
+  })
+})

client/src/extension.ts

@@ -13,13 +13,17 @@ import { BitbakeDriver } from './lib/src/BitbakeDriver'
 import { BitbakeTaskProvider } from './ui/BitbakeTaskProvider'
 import { registerBitbakeCommands } from './ui/BitbakeCommands'
 import { BitbakeWorkspace } from './ui/BitbakeWorkspace'
+import { BitbakeRecipesView } from './ui/BitbakeRecipesView'
+import { BitBakeProjectScannerClient } from './language/BitbakeProjectScannerClient'
 
 let client: LanguageClient
 const bitbakeDriver: BitbakeDriver = new BitbakeDriver()
 let bitbakeTaskProvider: BitbakeTaskProvider
 let taskProvider: vscode.Disposable
 const bitbakeWorkspace: BitbakeWorkspace = new BitbakeWorkspace()
 export let bitbakeExtensionContext: vscode.ExtensionContext
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+let bitbakeRecipesView: BitbakeRecipesView | undefined
 
 function loadLoggerSettings (): void {
   logger.level = vscode.workspace.getConfiguration('bitbake').get('loggingLevel') ?? 'info'
@@ -51,6 +55,10 @@ export async function activate (context: vscode.ExtensionContext): Promise<void>
 
   const notificationManager = new ClientNotificationManager(client, context.globalState)
   context.subscriptions.push(...notificationManager.buildHandlers())
+  const bitBakeProjectScannerClient = new BitBakeProjectScannerClient(client)
+  context.subscriptions.push(...bitBakeProjectScannerClient.buildHandlers())
+  bitbakeRecipesView = new BitbakeRecipesView(bitbakeWorkspace, bitBakeProjectScannerClient)
+  bitbakeRecipesView.registerView(context)
 
   // Handle settings change for bitbake driver
   context.subscriptions.push(vscode.workspace.onDidChangeConfiguration((event) => {

client/src/language/BitbakeProjectScannerClient.ts

@@ -0,0 +1,37 @@
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) 2023 Savoir-faire Linux. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ * ------------------------------------------------------------------------------------------ */
+
+import type * as vscode from 'vscode'
+import { type LanguageClient } from 'vscode-languageclient/node'
+import { type BitbakeScanResult } from '../lib/src/types/BitbakeScanResult'
+import EventEmitter from 'events'
+import { logger } from '../lib/src/utils/OutputLogger'
+
+/// Keeps track of the bitbake scan results from the language server
+export class BitBakeProjectScannerClient {
+  bitbakeScanResult: BitbakeScanResult = { recipes: [], includes: [] }
+  private readonly client: LanguageClient
+  onChange: EventEmitter = new EventEmitter()
+
+  constructor (client: LanguageClient) {
+    this.client = client
+  }
+
+  buildHandlers (): vscode.Disposable[] {
+    const handlers = [
+      this.bitbakeScanHandler()
+    ]
+
+    return handlers
+  }
+
+  private bitbakeScanHandler (): vscode.Disposable {
+    return this.client.onNotification('bitbake/scanReady', (scanResults: BitbakeScanResult) => {
+      this.bitbakeScanResult = scanResults
+      this.onChange.emit('scanReady', scanResults)
+      logger.info('Bitbake scan results received from language server')
+    })
+  }
+}

server/src/ElementInfo.ts → client/src/lib/src/types/BitbakeScanResult.ts

@@ -1,5 +1,5 @@
 /* --------------------------------------------------------------------------------------------
- * Copyright (c) Eugen Wiens. All rights reserved.
+ * Copyright (c) 2023 Savoir-faire Linux. All rights reserved.
  * Licensed under the MIT License. See License.txt in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 
@@ -26,3 +26,8 @@ export interface ElementInfo {
   overlayes?: PathInfo[]
   version?: string
 }
+
+export interface BitbakeScanResult {
+  recipes: ElementInfo[]
+  includes: ElementInfo[]
+}