refactor: add a test checking that resolvers are not called with empty version when building dashboard with added/removed packages

Author: b41ex

test/dashboards.test.ts

@@ -13,12 +13,78 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { describe, test, expect, jest } from '@jest/globals'
+import { LocalRegistry } from './helpers/registry'
+import { BUILD_TYPE, VERSION_STATUS } from '../src/consts'
+import { Editor } from './helpers/editor'
 
 describe('Dashboard build', () => {
   test('dashboard should have changes', async () => {
     // todo
   }, 100000)
-  test('changelog of dashboards should have changes', async () => {
-    // todo
+  test('Resolvers should not be called for empty versions when building changelog for dashboard that has added removed packages', async () => {
+    const pckg1Id = 'dashboards/pckg1'
+    const pckg2Id = 'dashboards/pckg2'
+
+    await LocalRegistry.openPackage(pckg1Id).publish(pckg1Id, {
+      version: 'v1',
+      packageId: pckg1Id,
+      files: [{ fileId: 'v1.yaml' }],
+    })
+
+    await LocalRegistry.openPackage(pckg2Id).publish(pckg2Id, {
+      version: 'v2',
+      packageId: pckg2Id,
+      files: [{ fileId: 'v2.yaml' }],
+    })
+
+    const dashboard = LocalRegistry.openPackage('dashboards/dashboard')
+    await dashboard.publish(dashboard.packageId, {
+      packageId: 'dashboards/dashboard',
+      version: 'v1',
+      apiType: 'rest',
+      refs: [
+        { refId: pckg1Id, version: 'v1' },
+      ],
+    })
+
+    await dashboard.publish(dashboard.packageId, {
+      packageId: 'dashboards/dashboard',
+      version: 'v2',
+      apiType: 'rest',
+      refs: [
+        { refId: pckg2Id, version: 'v2' },
+      ],
+    })
+
+    const editor = new Editor(dashboard.packageId, {
+      version: 'v2',
+      packageId: dashboard.packageId,
+      previousVersionPackageId: dashboard.packageId,
+      previousVersion: 'v1',
+      buildType: BUILD_TYPE.CHANGELOG,
+      status: VERSION_STATUS.RELEASE,
+    })
+    const versionResolverSpy = jest.spyOn(editor.registry as LocalRegistry, 'versionResolver')
+    const versionDocumentsResolverSpy = jest.spyOn(editor.registry as LocalRegistry, 'versionDocumentsResolver')
+    const rawDocumentResolverSpy = jest.spyOn(editor.registry as LocalRegistry, 'rawDocumentResolver')
+
+    await editor.run()
+
+    // versionResolver(version, packageId)
+    versionResolverSpy.mock.calls.forEach(args => {
+      // args: [packageId = '', version]
+      expect(args[1]).toBeTruthy()
+    })
+
+    // versionDocumentsResolver(version, packageId)
+    versionDocumentsResolverSpy.mock.calls.forEach(args => {
+      expect(args[0]).toBeTruthy()
+    })
+
+    // rawDocumentResolver(version, packageId, slug)
+    rawDocumentResolverSpy.mock.calls.forEach(args => {
+      expect(args[0]).toBeTruthy()
+    })
   }, 100000)
 })

test/projects/dashboards/pckg1/v1.yaml

@@ -0,0 +1,14 @@
+openapi: "3.0.0"
+info:
+  title: some test
+  version: 0.1.0
+paths:
+  /some/path1:
+    summary: some path item summary
+    description: some path item description
+    get:
+      summary: some operation summary
+      description: some operation description
+      responses:
+        '200':
+          description: some response description

test/projects/dashboards/pckg1/v2.yaml

@@ -0,0 +1,14 @@
+openapi: "3.0.0"
+info:
+  title: some test
+  version: 0.1.0
+paths:
+  /some/path1:
+    summary: some path item summary
+    description: some path item description
+    get:
+      summary: some operation summary
+      description: changed some operation description
+      responses:
+        '200':
+          description: some response description

test/projects/dashboards/pckg2/v1.yaml

@@ -0,0 +1,14 @@
+openapi: "3.0.0"
+info:
+  title: some test
+  version: 0.1.0
+paths:
+  /some/path2:
+    summary: some path item summary
+    description: some path item description
+    get:
+      summary: some operation summary
+      description: some operation description
+      responses:
+        '200':
+          description: some response description

test/projects/dashboards/pckg2/v2.yaml

@@ -0,0 +1,14 @@
+openapi: "3.0.0"
+info:
+  title: some test
+  version: 0.1.0
+paths:
+  /some/path2:
+    summary: some path item summary
+    description: some path item description
+    get:
+      summary: some operation summary
+      description: changed some operation description
+      responses:
+        '200':
+          description: some response description