JS-312 Create rule S1607 (no-skipped-tests): Tests should not be skipped without providing a reason

its/ruling/src/test/expected/jsts/desktop/typescript-S1607.json

@@ -0,0 +1,8 @@
+{
+"desktop:app/test/unit/git/reset-test.ts": [
+35
+],
+"desktop:app/test/unit/git/status-test.ts": [
+287
+]
+}

packages/jsts/src/rules/S1607/fixtures/jasmine/cb.fixture.js

@@ -0,0 +1,43 @@
+// Test cases with Jasmine
+
+describe('foo', function() {
+ it('should do something', function(done) {
+ done();
+ });
+});
+
+describe('foo', function() {
+ // Reason: There is a bug in the code
+ xit('should do something', function(done) { // Compliant
+ done();
+ });
+});
+
+
+describe('foo', function() {
+ xit('should do something', function(done) { // Noncompliant {{Remove this unit test or explain why it is ignored.}}
+//^^^
+ done();
+ });
+});
+
+describe('foo', function() {
+ xcontext('foo', function() { // Noncompliant
+ it('should do something', function(done) {
+ done();
+ });
+ });
+});
+
+xdescribe('foo', function() { // Noncompliant
+ it('should do something', function(done) {
+ done();
+ });
+});
+
+describe('foo', function() {
+ //
+ xit('should do something', function(done) { // Noncompliant
+ done();
+ });
+});

packages/jsts/src/rules/S1607/fixtures/jasmine/cb.test.ts

@@ -0,0 +1,35 @@
+/*
+ * SonarQube JavaScript Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+import { basename } from 'path';
+import { check } from '../../../../../tests/tools';
+import { rule } from '../../';
+import { clearPackageJsons, loadPackageJsons } from '../../../helpers';
+
+const sonarId = basename(__dirname);
+
+describe('Rule S1607', () => {
+ beforeEach(() => {
+ loadPackageJsons(__dirname, []);
+ });
+ afterAll(() => {
+ clearPackageJsons();
+ });
+ check(sonarId, rule, __dirname);
+});

packages/jsts/src/rules/S1607/fixtures/jasmine/package.json

@@ -0,0 +1,5 @@
+{
+ "devDependencies": {
+ "jasmine": "1.2.3"
+ }
+}

packages/jsts/src/rules/S1607/fixtures/jest/cb.fixture.js

@@ -0,0 +1,52 @@
+// Test cases with Jest
+
+describe('foo', function() {
+ it('should do something', function(done) {
+ done();
+ });
+});
+
+describe('foo', function() {
+ // Reason: There is a bug in the code
+ it.skip('should do something', function(done) { // Compliant
+ done();
+ });
+});
+
+
+describe('foo', function() {
+ it.skip('should do something', function(done) { // Noncompliant {{Remove this unit test or explain why it is ignored.}}
+//^^^^^^^
+ done();
+ });
+});
+
+describe('foo', function() {
+ test.skip('should do something', function(done) { // Noncompliant
+ done();
+ });
+});
+
+describe.skip('foo', function() { // Noncompliant
+ it('should do something', function(done) {
+ done();
+ });
+});
+
+describe('foo', function() {
+ xit('should do something', function(done) { // Noncompliant
+ done();
+ });
+});
+
+describe('foo', function() {
+ xtest('should do something', function(done) { // Noncompliant
+ done();
+ });
+});
+
+xdescribe('foo', function() { // Noncompliant
+ it('should do something', function(done) {
+ done();
+ });
+});

packages/jsts/src/rules/S1607/fixtures/jest/cb.test.ts

@@ -0,0 +1,35 @@
+/*
+ * SonarQube JavaScript Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+import { basename } from 'path';
+import { check } from '../../../../../tests/tools';
+import { rule } from '../../';
+import { clearPackageJsons, loadPackageJsons } from '../../../helpers';
+
+const sonarId = basename(__dirname);
+
+describe('Rule S1607', () => {
+ beforeEach(() => {
+ loadPackageJsons(__dirname, []);
+ });
+ afterAll(() => {
+ clearPackageJsons();
+ });
+ check(sonarId, rule, __dirname);
+});

packages/jsts/src/rules/S1607/fixtures/jest/package.json

@@ -0,0 +1,5 @@
+{
+ "devDependencies": {
+ "jest": "1.2.3"
+ }
+}

packages/jsts/src/rules/S1607/fixtures/mocha/cb.fixture.js

@@ -0,0 +1,36 @@
+// Test cases with Mocha
+
+describe('foo', function() {
+ it('should do something', function(done) {
+ done();
+ });
+});
+
+describe('foo', function() {
+ // Reason: There is a bug in the code
+ it.skip('should do something', function(done) { // Compliant
+ done();
+ });
+});
+
+
+describe('foo', function() {
+ it.skip('should do something', function(done) { // Noncompliant {{Remove this unit test or explain why it is ignored.}}
+//^^^^^^^
+ done();
+ });
+});
+
+describe('foo', function() {
+ context.skip('foo', function() { // Noncompliant
+ it('should do something', function(done) {
+ done();
+ });
+ });
+});
+
+describe.skip('foo', function() { // Noncompliant
+ it('should do something', function(done) {
+ done();
+ });
+});

packages/jsts/src/rules/S1607/fixtures/mocha/cb.test.ts

@@ -0,0 +1,35 @@
+/*
+ * SonarQube JavaScript Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+import { basename } from 'path';
+import { check } from '../../../../../tests/tools';
+import { rule } from '../../';
+import { clearPackageJsons, loadPackageJsons } from '../../../helpers';
+
+const sonarId = basename(__dirname);
+
+describe('Rule S1607', () => {
+ beforeEach(() => {
+ loadPackageJsons(__dirname, []);
+ });
+ afterAll(() => {
+ clearPackageJsons();
+ });
+ check(sonarId, rule, __dirname);
+});

packages/jsts/src/rules/S1607/fixtures/mocha/package.json

@@ -0,0 +1,5 @@
+{
+ "devDependencies": {
+ "mocha": "1.2.3"
+ }
+}

packages/jsts/src/rules/S1607/fixtures/nodejs/cb.fixture.js

@@ -0,0 +1,60 @@
+// Test cases with Node.js
+
+const test = require('node:test');
+
+test('should do something', function(t) {
+ t.assert.ok(true);
+});
+
+test('should do something', { skip: 'There is a bug in the code' }, function(t) { // Compliant
+ t.assert.ok(true);
+});
+
+test('should do something', { skip: true }, function(t) { // Noncompliant {{Remove this unit test or explain why it is ignored.}}
+// ^^^^^^^^^^
+ t.assert.ok(true);
+});
+
+test('should do something', { skip: '' }, function(t) { // Noncompliant
+ t.assert.ok(true);
+});
+
+test('should do something', function(t) {
+ t.skip('There is a bug in the code'); // Compliant
+});
+
+test('should do something', function(t) {
+ t.skip(); // Noncompliant
+});
+
+test('should do something', function(t) {
+ t.skip(''); // Noncompliant
+});
+
+test('should do something');
+
+test('should do something', unknown);
+
+test('should do something', function() {
+
+});
+
+test('should do something', function(t) {
+
+});
+
+test('should do something', function(t) {
+ t.diagnostic('A diagnostic message');
+});
+
+test('should do something', 42, function() {
+
+});
+
+test('should do something', {}, function() {
+
+});
+
+test('should do something', { skip: false }, function() {
+
+});

packages/jsts/src/rules/S1607/fixtures/nodejs/cb.test.ts

@@ -0,0 +1,35 @@
+/*
+ * SonarQube JavaScript Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+import { basename } from 'path';
+import { check } from '../../../../../tests/tools';
+import { rule } from '../../';
+import { clearPackageJsons, loadPackageJsons } from '../../../helpers';
+
+const sonarId = basename(__dirname);
+
+describe('Rule S1607', () => {
+ beforeEach(() => {
+ loadPackageJsons(__dirname, []);
+ });
+ afterAll(() => {
+ clearPackageJsons();
+ });
+ check(sonarId, rule, __dirname);
+});

packages/jsts/src/rules/S1607/fixtures/nodejs/package.json

@@ -0,0 +1 @@
+{}

packages/jsts/src/rules/S1607/index.ts

@@ -0,0 +1,20 @@
+/*
+ * SonarQube JavaScript Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+export { rule } from './rule';