feat: add unit tests for tools scripts #2011

reachaadrika · 2023-07-30T11:41:47Z

Description

The scripts in Tools folder , make sure that tools are extracted correctly from github , and are converted to their respective related JSON folders , so that they could be displayed on the UI of tools dashboard .
Main files , that make sure , the scripts work uniformly are :
extract-tools-github : This script extracts the tools data from github .
combine-tools : There are 2 test files :manual and automated tests , it combines these files and pushes it into json files , Also adds languages and tech if it is not found .
tools-object
build-tools

Related issue(s)
fixes #2010

netlify · 2023-07-30T11:41:54Z

✅ Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`195b1ad`
🔍 Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/64f8ba63162da8000752de79
😎 Deploy Preview	https://deploy-preview-2011--asyncapi-website.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

github-actions · 2023-07-30T11:43:52Z

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🔴 Performance	21
🟢 Accessibility	98
🟢 Best practices	100
🟢 SEO	100
🔴 PWA	30

Lighthouse ran on https://deploy-preview-2011--asyncapi-website.netlify.app/

akshatnema · 2023-08-01T17:54:53Z

cypress/test/scripts/tools/extract-tools-github.cy.js

+    // eslint-disable-next-line cypress/no-async-tests
+    it('fetches AsyncAPI tools from Github', async () => {
+        // Define the data that the API should return (stubbed response) // this is mock data from tools.schema{}
+        const stubbedResponse = {


stubbedResponse is not a proper mock response.

akshatnema · 2023-08-01T18:01:37Z

cypress/test/scripts/build-tools.cy.js

+  // eslint-disable-next-line cypress/no-async-tests
+  it('fetches and saves in tools.json ',async () => {
+    // Define the data that the API should return (stubbed response)
+    const stubbedResponse = {


Kindly correct the stubbedResponse according to the Github API response.

akshatnema · 2023-08-01T18:02:51Z

cypress/test/scripts/tools/tools-object.cy.js

+  const testToolFile = {
+    title: 'Test Tool',
+    description: 'This is a test tool',
+    links: {
+      repoUrl: 'https://github.com/testuser/test-repo'
+    },
+    filters: {
+      hasCommercial: true
+    }
+  };


Why testToolFile doesn't consists of language, category and technology fields?

akshatnema · 2023-08-01T18:04:27Z

cypress/test/scripts/tools/combine-tools.cy.js

+
+

Suggested change

akshatnema · 2023-08-01T18:04:52Z

cypress/test/scripts/tools/extract-tools-github.cy.js

@@ -0,0 +1,199 @@
+import { getData } from "../../../../scripts/tools/extract-tools-github";
+describe('Get Data', () => {
+    // eslint-disable-next-line cypress/no-async-tests


Why did we add this comment?

cypress eslint does n't allow async and await , thus to disable eslint this was added

You can ignore the eslint warnings in the files.

akshatnema · 2023-08-01T18:36:55Z

cypress/test/scripts/tools/tools-object.cy.js

+    }
+    // Call the function directly with the mocked data
+    convertTools(mockData).then((finalToolsObject) => {
+      expect(finalToolsObject).to.exist;


finalToolsObject returned from the function contains every toolsList empty right now. Kindly check for a tool added inside the toolsList for a certain category.

akshatnema · 2023-08-01T18:39:45Z

cypress/test/scripts/tools/combine-tools.cy.js

+
+

Suggested change

akshatnema · 2023-08-01T18:40:00Z

cypress/test/scripts/tools/combine-tools.cy.js

+
+        });
+    });
+});


Suggested change

});

});

akshatnema · 2023-08-01T18:43:40Z

cypress/test/scripts/tools/combine-tools.cy.js

+        });
+    });
+});
+describe('getFinalTool function', () => {


Suggested change

describe('getFinalTool function', () => {

describe('combineTools function', () => {

akshatnema · 2023-08-01T18:44:19Z

cypress/test/scripts/tools/combine-tools.cy.js

+    });
+});
+describe('getFinalTool function', () => {
+    it('should update the toolObject with language and technology tags if they exist', () => {


Suggested change

it('should update the toolObject with language and technology tags if they exist', () => {

it('should able to merge automatedTools and manualTools', () => {

…rika/website into scripts_dashboard_tests

akshatnema · 2023-09-06T17:34:45Z

@reachaadrika Any updates on this?

reachaadrika · 2023-09-06T17:44:38Z

Researching on this part , it requires a lot of research , maybe will come up with something by the end of this week , I was a bit busy this week

github-actions · 2024-01-05T00:18:22Z

This pull request has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this pull request, add a comment with detailed explanation.

There can be many reasons why some specific pull request has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this pull request forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

AnimeshKumar923 · 2024-01-05T03:00:38Z

any updates on this? @reachaadrika

cc: @akshatnema @derberg @magicmatatjahu @Mayaleeeee

akshatnema · 2024-01-13T06:43:49Z

@AnimeshKumar923 We have some other plans for the tests now. Let's wait for approvals from other maintainers/TSC members regarding it.

add tests for tools scripts

336ab42

reachaadrika requested review from derberg, akshatnema, magicmatatjahu, Mayaleeeee and asyncapi-bot-eve as code owners July 30, 2023 11:41

basic fixes

64b4263

akshatnema added the gsoc This label should be used for issues or discussions related to ideas for Google Summer of Code label Jul 31, 2023

akshatnema requested changes Aug 1, 2023

View reviewed changes

reachaadrika and others added 11 commits August 2, 2023 00:36

Merge branch 'master' into scripts_dashboard_tests

3232cae

revert script changes

9f1827b

Merge branch 'master' into scripts_dashboard_tests

5e9b54c

Merge branch 'master' into scripts_dashboard_tests

e6aad35

Merge branch 'master' into scripts_dashboard_tests

5f3470c

Merge branch 'scripts_dashboard_tests' of https://github.com/reachaad…

a2ae9a6

…rika/website into scripts_dashboard_tests

initial tool updates

6611569

configure e2e tests and cypress migration to latest

fb99756

require

d74ed12

initial

063a1e6

Merge branch 'master' into scripts_dashboard_tests

f38a4cc

Merge branch 'master' into scripts_dashboard_tests

195b1ad

github-actions bot added the stale label Jan 5, 2024

github-actions bot removed the stale label Jan 6, 2024

akshatnema closed this Jan 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add unit tests for tools scripts #2011

feat: add unit tests for tools scripts #2011

reachaadrika commented Jul 30, 2023

netlify bot commented Jul 30, 2023 •

edited

Loading

github-actions bot commented Jul 30, 2023 •

edited

Loading

akshatnema Aug 1, 2023

akshatnema Aug 1, 2023

akshatnema Aug 1, 2023

akshatnema Aug 1, 2023

akshatnema Aug 1, 2023

reachaadrika Aug 1, 2023

akshatnema Aug 10, 2023

akshatnema Aug 1, 2023

akshatnema Aug 1, 2023

akshatnema Aug 1, 2023

akshatnema Aug 1, 2023

akshatnema Aug 1, 2023

akshatnema commented Sep 6, 2023

reachaadrika commented Sep 6, 2023

github-actions bot commented Jan 5, 2024

AnimeshKumar923 commented Jan 5, 2024

akshatnema commented Jan 13, 2024

	describe('getFinalTool function', () => {
	describe('combineTools function', () => {

	it('should update the toolObject with language and technology tags if they exist', () => {
	it('should able to merge automatedTools and manualTools', () => {

feat: add unit tests for tools scripts #2011

feat: add unit tests for tools scripts #2011

Conversation

reachaadrika commented Jul 30, 2023

netlify bot commented Jul 30, 2023 • edited Loading

✅ Deploy Preview for asyncapi-website ready!

github-actions bot commented Jul 30, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akshatnema commented Sep 6, 2023

reachaadrika commented Sep 6, 2023

github-actions bot commented Jan 5, 2024

AnimeshKumar923 commented Jan 5, 2024

akshatnema commented Jan 13, 2024

netlify bot commented Jul 30, 2023 •

edited

Loading

github-actions bot commented Jul 30, 2023 •

edited

Loading