Merge pull request #596 from alikon/initial-webservices-tests

prepare for webservices testings
still room for improvements for GSoC studentes

Author: alikon

cypress.config.dist.js

@@ -7,7 +7,7 @@ export default defineConfig({
   screenshotsFolder: 'tests/cypress/output/screenshots',
   viewportHeight: 1000,
   viewportWidth: 1200,
-  e2e:  {
+  e2e: {
     setupNodeEvents(on, config) {
       setupPlugins(on, config);
     },
@@ -16,6 +16,7 @@ export default defineConfig({
       'tests/cypress/integration/install/*.cy.{js,jsx,ts,tsx}',
       'tests/cypress/integration/administrator/**/*.cy.{js,jsx,ts,tsx}',
       'tests/cypress/integration/site/**/*.cy.{js,jsx,ts,tsx}',
+      'tests/cypress/integration/api/**/*.cy.{js,jsx,ts,tsx}',
       'tests/cypress/integration/plugins/**/*.cy.{js,jsx,ts,tsx}',
     ],
     supportFile: 'tests/cypress/support/index.js',

jorobo.dist.ini

@@ -1,5 +1,5 @@
 extension = weblinks
-version = 4.0.0
+version = 5.0.0-dev
 source = src
 target = package
 
@@ -8,7 +8,7 @@ target = package
 ; and add Release to the target (separated by space) above
 [github]
 remote = origin
-branch = develop
+branch = 5.x-dev
 token =
 owner = joomla-extensions
 repository = weblinks

src/api/components/com_weblinks/src/View/Weblinks/JsonApiView.php renamed to src/api/components/com_weblinks/src/View/Weblinks/JsonapiView.php

@@ -22,7 +22,7 @@
  *
  * @since  __DEPLOY_VERSION__
  */
-class JsonApiView extends BaseApiView
+class JsonapiView extends BaseApiView
 {
     /**
      * The fields to render item in the documents

tests/cypress/integration/administrator/components/com_weblinks/CheckPackage.cy.js

@@ -58,6 +58,8 @@ describe('Test that the weblinks extension package', () => {
       .within(() => {
         cy.get('td').eq(2).should('contain', 'Administrator'); // Location column
         cy.get('td').eq(3).should('contain', 'Component'); // Type column
+        // todo make version check dinamic
+        // cy.get('td').eq(4).should('contain', '5.0.0-dev'); // Version column
         cy.get('td').eq(7).should('contain', 'N/A'); // Folder column
       });
   });

tests/cypress/integration/api/com_weblinks/Weblinks.cy.js

@@ -0,0 +1,59 @@
+describe('Test that weblinks API endpoint', () => {
+  afterEach(() => cy.task('queryDB', "DELETE FROM #__weblinks WHERE title LIKE '%automated test weblink%'"));
+
+  it('can deliver a list of weblinks', () => {
+    cy.db_enableExtension('1', 'plg_webservices_weblinks');
+    cy.db_createWeblink({ title: 'automated test weblink' })
+      .then(() => cy.api_get('/weblinks'))
+      .then((response) => cy.wrap(response).its('body').its('data.0').its('attributes')
+        .its('title')
+        .should('include', 'automated test weblink'));
+    cy.db_enableExtension('0', 'plg_webservices_weblinks');
+  });
+
+  it('can deliver a single weblink', () => {
+    cy.db_enableExtension('1', 'plg_webservices_weblinks');
+    cy.db_createWeblink({ title: 'automated test weblink' })
+      .then((weblink) => cy.api_get(`/weblinks/${weblink.id}`))
+      .then((response) => cy.wrap(response).its('body').its('data').its('attributes')
+        .its('title')
+        .should('include', 'automated test weblink'));
+    cy.db_enableExtension('0', 'plg_webservices_weblinks');
+  });
+
+  it('can create a weblink', () => {
+    cy.db_enableExtension('1', 'plg_webservices_weblinks');
+    cy.db_createCategory({ extension: 'com_weblinks' })
+      .then((categoryId) => cy.api_post('/weblinks', {
+        title: 'automated test weblink',
+        alias: 'test-weblink',
+        url: 'http://example.com',
+        description: 'automated test weblink description',
+        catid: categoryId,
+        state: 1,
+        language: '*',
+      }))
+      .then((response) => cy.wrap(response).its('body').its('data').its('attributes')
+        .its('title')
+        .should('include', 'automated test weblink'));
+    cy.db_enableExtension('0', 'plg_webservices_weblinks');
+  });
+
+  it('can update a weblink', () => {
+    cy.db_enableExtension('1', 'plg_webservices_weblinks');
+    cy.db_createWeblink({ title: 'automated test weblink' })
+      .then((weblink) => cy.api_patch(`/weblinks/${weblink.id}`, { title: 'updated automated test weblink' }))
+      .then((response) => cy.wrap(response).its('body').its('data').its('attributes')
+        .its('title')
+        .should('include', 'updated automated test weblink'));
+    cy.db_enableExtension('0', 'plg_webservices_weblinks');
+  });
+
+  it('can delete a weblink', () => {
+    cy.db_enableExtension('1', 'plg_webservices_weblinks');
+    cy.db_createWeblink({ title: 'automated test weblink', state: -2 })
+      .then((weblink) => cy.api_delete(`/weblinks/${weblink.id}`))
+      .then((response) => cy.wrap(response).its('status').should('eq', 204));
+    cy.db_enableExtension('0', 'plg_webservices_weblinks');
+  });
+});

tests/cypress/integration/install/install.cy.js

@@ -8,5 +8,7 @@ describe('Install Joomla and Weblinks package', () => {
     cy.disableStatistics()
     cy.setErrorReportingToDevelopment()
     cy.doAdministratorLogout()
+    // Update to the correct secret for the API tests because of the bearer token
+    cy.config_setParameter('secret', 'tEstValue');
   })
 })