Clean Code on Lorbic

Testing Types

Tue, 11 Mar 2025 09:32:00 +0000

Understanding different types of software testing is crucial for delivering a reliable application. Smoke Testing checks basic stability after a new build, while Sanity Testing verifies specific bug fixes or minor updates. Functional Testing ensures that features work as expected based on business requirements. Regression Testing prevents new changes from breaking existing functionality. End-to-End (E2E) Testing simulates real-world user workflows, and Performance Testing checks system speed, load handling capacity, and responsiveness. Implementing these (some or all) test types helps maintain software quality and prevent critical failures.

Go Clean Code Guidelines

Sun, 22 Sep 2024 15:22:00 +0000

Go Clean Code Guidelines for Code Quality and Maintainability.

When it comes to writing clean, maintainable code, there are a few fundamental rules that can help improve the overall structure and quality of your codebase. As engineers, our goal should be to keep things simple, clear, and scalable. With this in mind, here are some guidelines which prioritize code readability, functional clarity, and the overall maintainability of a project. These guidelines are based on principles from clean code, SOLID, and functional programming while emphasizing simplicity over unnecessary complexity.

SOLID and Functional Programming Principles in Go

Sun, 22 Sep 2024 00:03:00 +0000

Let’s go through the SOLID principles and functional programming principles that can apply to your Go codebase. I’ll provide simple Go examples along with brief explanations to show how each principle can improve code quality.

SOLID Principles

Single Responsibility Principle (SRP)

Description: A class or function should have only one reason to change, meaning it should only have one job or responsibility.

Example:

 1// Good: Separate responsibilities into two functions
 2type EmailSender struct{}
 3
 4
 5func (e *EmailSender) SendEmail(to, subject, body string) {
 6 // logic for sending email
 7}
 8
 9
10func formatEmailBody(template string, data map[string]string) string {
11 // logic for formatting the email body
12 return ""
13}
14
15
16// Avoid: Single function doing multiple jobs
17func sendFormattedEmail(to, subject, template string, data map[string]string) {
18 body := formatEmailBody(template, data)
19 // email sending logic mixed with formatting
20}

Open/Closed Principle (OCP)