Troubleshooting of Sonar issue - Revision history

Planetoid: /* How to resolve "Define a constant instead of duplicating this literal" */

2025-05-28T14:47:41Z

How to resolve "Define a constant instead of duplicating this literal"

← Older revision		Revision as of 22:47, 28 May 2025
Line 59:		Line 59:
	Error condition which met "Define a constant instead of duplicating this literal" - violates DRY (Don't Repeat Yourself) principle and creates maintenance issues <ref>[Clean Code principles - Avoid Magic Numbers/Strings]</ref>		Error condition which met "Define a constant instead of duplicating this literal" - violates DRY (Don't Repeat Yourself) principle and creates maintenance issues <ref>[Clean Code principles - Avoid Magic Numbers/Strings]</ref>

	Original problematic code:		Original problematic code (Python):
	<pre>		<pre>
	def parse_date(row):		def parse_date(row):

Planetoid: /* How to resolve "Define a constant instead of duplicating this literal" */

2025-05-28T09:43:00Z

How to resolve "Define a constant instead of duplicating this literal"

← Older revision		Revision as of 17:43, 28 May 2025
Line 71:		Line 71:
	</pre>		</pre>

	Possible solution:		Possible solution: define the constants
	<pre>		<pre>
	# Date format constants		# Date format constants
Line 90:		Line 90:
	# Consistency: All date formatting uses the same format definitions		# Consistency: All date formatting uses the same format definitions
	# Error Prevention: Reduces risk of typos in repeated string literals		# Error Prevention: Reduces risk of typos in repeated string literals


	=== How to resolve "Define and throw a dedicated exception instead of using a generic one" ===		=== How to resolve "Define and throw a dedicated exception instead of using a generic one" ===

Planetoid at 09:40, 28 May 2025

2025-05-28T09:40:37Z

← Older revision		Revision as of 17:40, 28 May 2025
Line 1:		Line 1:
	Troubleshooting of SonarQube issue		Troubleshooting of SonarQube issue

	~~{{Draft}}~~

	{{Tip \| tip='''What is SonarQube?''' SonarQube is an open-source platform for continuous code quality inspection using static program analysis to detect bugs and code smells across multiple programming languages. It provides automated analysis reports and integrates seamlessly with various development tools. (Source: [https://en.wikipedia.org/wiki/SonarQube Wikipedia])}}		{{Tip \| tip='''What is SonarQube?''' SonarQube is an open-source platform for continuous code quality inspection using static program analysis to detect bugs and code smells across multiple programming languages. It provides automated analysis reports and integrates seamlessly with various development tools. (Source: [https://en.wikipedia.org/wiki/SonarQube Wikipedia])}}

Planetoid: + How to resolve "Define a constant instead of duplicating this literal"

2025-05-28T09:40:04Z

+ How to resolve "Define a constant instead of duplicating this literal"

@@ Line 55: / Line 55: @@
 * Grant the execution permission {{kbd | key=chmod +x add_newline_to_php_files.sh}}
 * Usage {{kbd | key=<nowiki>./add_newline_to_php_files.sh /path/to/php/directory_of_scripts</nowiki>}}
 === How to resolve "Define and throw a dedicated exception instead of using a generic one" ===

Planetoid at 10:11, 10 April 2025

2025-04-10T10:11:08Z

← Older revision		Revision as of 18:11, 10 April 2025
Line 3:		Line 3:
	{{Draft}}		{{Draft}}

	{{Tip \| tip='''What is SonarQube?''' SonarQube is an open-source platform for continuous code quality inspection using static program analysis to detect bugs and code smells across multiple programming languages. It provides automated analysis reports and integrates seamlessly with various development tools.}}		{{Tip \| tip='''What is SonarQube?''' SonarQube is an open-source platform for continuous code quality inspection using static program analysis to detect bugs and code smells across multiple programming languages. It provides automated analysis reports and integrates seamlessly with various development tools. (Source: [https://en.wikipedia.org/wiki/SonarQube Wikipedia])}}

	== SonarQube issues ==		== SonarQube issues ==

Planetoid at 11:16, 9 April 2025

2025-04-09T11:16:16Z

← Older revision		Revision as of 19:16, 9 April 2025
Line 2:		Line 2:

	{{Draft}}		{{Draft}}

			{{Tip \| tip='''What is SonarQube?''' SonarQube is an open-source platform for continuous code quality inspection using static program analysis to detect bugs and code smells across multiple programming languages. It provides automated analysis reports and integrates seamlessly with various development tools.}}

	== SonarQube issues ==		== SonarQube issues ==

Planetoid: /* Unresolved issues */

2025-04-09T11:00:53Z

Unresolved issues

← Older revision		Revision as of 19:00, 9 April 2025
Line 182:		Line 182:
	* [https://medium.com/@Kfir-G/securing-docker-non-root-user-best-practices-5784ac25e755 Securing Docker: Non-Root User Best Practices \| by Kfir Gisman \| Medium]		* [https://medium.com/@Kfir-G/securing-docker-non-root-user-best-practices-5784ac25e755 Securing Docker: Non-Root User Best Practices \| by Kfir Gisman \| Medium]

	== Unresolved issues ==		=== Unresolved issues ===
	* SonarLint: Replace "require_once" with namespace import mechanism through the "use" keyword.		* SonarLint: Replace "require_once" with namespace import mechanism through the "use" keyword.

Planetoid: + This image might run with root as the default user. Make sure it is safe here.

2025-04-09T11:00:24Z

+ This image might run with root as the default user. Make sure it is safe here.

@@ Line 1: / Line 1: @@
 {{Draft}}
-== How to resolve "Add a new line at the end of this file." ==
+== SonarQube issues ==
 Error message: Files should contain an empty newline at the end<ref>[https://gist.github.com/OleksiyRudenko/d51388345ea55767b7672307fe35adf3 Why should text files end with a newline?]</ref>
@@ Line 52: / Line 54: @@
 * Usage {{kbd | key=<nowiki>./add_newline_to_php_files.sh /path/to/php/directory_of_scripts</nowiki>}}
-== How to resolve "Define and throw a dedicated exception instead of using a generic one" ==
+=== How to resolve "Define and throw a dedicated exception instead of using a generic one" ===
 Error condition which met "Define and throw a dedicated exception instead of using a generic one" <ref>[https://cwe.mitre.org/data/definitions/397 CWE - CWE-397: Declaration of Throws for Generic Exception (4.12)]</ref>
@@ Line 70: / Line 72: @@
 </pre>
-== How to resolve "Merge this if statement with the enclosing one." ==
+=== How to resolve "Merge this if statement with the enclosing one." ===
 Example of Code Not Meeting Standards
 <pre>
@@ Line 111: / Line 113: @@
 </pre>
-== How to resolve "Method visibility should be explicitly declared" ==
+=== How to resolve "Method visibility should be explicitly declared" ===
 Possible solution
@@ Line 119: / Line 121: @@
 * Replace with: {{kbd | key=<nowiki>$1public function$3</nowiki>}}
-== How to resolve "replace all tab characters in this file by sequences of white-spaces (Tabulation characters should not be used)" ==
+=== How to resolve "replace all tab characters in this file by sequences of white-spaces (Tabulation characters should not be used)" ===
 Solution: Using the editor which supports [[Regular expression | regular expression]]<ref>[https://community.sonarsource.com/t/replace-all-tab-characters-in-this-file-by-sequences-of-white-spaces-error-in-sonarcloud-t-sql/40078 Replace all tab characters in this file by sequences of white-spaces - Error in SonarCloud T-SQL - SonarCloud - Sonar Community]</ref>
 * Replace {{kbd | key=<nowiki>\t</nowiki>}}
 * with {{kbd | key=<nowiki>    </nowiki>}} (four whitespaces)
-== How to resolve "Refactor this function to reduce its Cognitive Complexity from XX to the 15 allowed." ==
+=== How to resolve "Refactor this function to reduce its Cognitive Complexity from XX to the 15 allowed." ===
 Possible solution<ref>[https://www.compozelabs.com/post/avoiding-and-fix-spaghetti-code How to fix your spaghetti code (and avoid it in the first place) | Compoze Labs]</ref><ref>[https://en.wikipedia.org/wiki/Spaghetti_code Spaghetti code - Wikipedia]</ref>
@@ Line 130: / Line 132: @@
 * Avoid nested conditionals
 * Simplify boolean expressions
 == Unresolved issues ==
@@ Line 149: / Line 200: @@
 [[Category: PHP]]
 [[Category: Security]]

Unknown user: /* How to resolve "Method visibility should be explicitly declared" */

2023-10-26T10:34:11Z

How to resolve "Method visibility should be explicitly declared"

@@ Line 68: / Line 68: @@
              throw new InvalidArgumentException($error);
+         }
 </pre>

Unknown user at 03:50, 7 October 2023

2023-10-07T03:50:07Z

← Older revision		Revision as of 11:50, 7 October 2023
Line 106:		Line 106:

	[[Category: Programming]]		[[Category: Programming]]
			[[Category: PHP]]
	[[Category: Security]]		[[Category: Security]]