judge-girl/code-quality-inspection

A code quality inspection (CQI) implementation.

Judge Girl

Judge Girl is under incubation and is actively developed (here to see the Scrum kanban). The document may be obsolete. Feel free to contact [email protected] or leave issues, open a thread in the discussions page if you are interested in any apsect.

Setup & Build

Clone the project (must include the submodule): git clone --recursive (This repository depends on the submodule Judge-Girl/Code-Quality-Inspection so the --recursive flag is needed)

1. Rename application.example.yml, application-mysql.example.yml, application-mongo.example.yml and application-redis.example.yml under the Spring-Boot/Spring-Boot-Commons/src/main/resources/config/ folder to application.yml, application-mysql.yml, application-mongo.yml and application-redis.yml respectively, and then replace the PLACEHOLDERs in these files with the values to fit your need.
2. Rename infra.example.yml to infra.yml and replace the PLACEHOLDERs with the values in the file to fit your need.

Run the entire Judge-Girl's backend locally

For those who wants to run all-in-one deployment locally, please do the following:

1. Create a judge-girl network by docker network create judge-girl
2. Run the infra component by docker-compose -f infra.yml
3. Build and run the application by sh run.sh

Contributing

Contributions are welcome, especially 'software-design' nerds are welcomed to taste the practice of microservice/OOD/clean-architecture/domain-driven-design with us.

Thanks to all the people who already contributed!

Software Design (Clean Architecture/DDD)

This project is a taste of the practicality of (Topological) Microservice, Clean Architecture and Domain-Driven Design (DDD). Topological Microservice emphasizes that Judge-Girl should be capable of being deployed in a form of both monoliths or microservices. (Currently, we only support the microservices option)

Here are some overview introductions of our software design. For more details, please navigate to the docs/ folder.

Judge Girl follows clean-architecture and DDD. The package structure is based on four bounded context (Student, Problem, Submission, Academy) with three design forces (Domain Logic, Tech Stack, Client).

The following represents our primary package structure that practices clean architecture.

├── API (Force: Client)
│   ├── API-Commons
│   ├── Judger-API
│   ├── Student-API
│   ├── Problem-API
│   └── Submission-API
├── Domain (Force: Domain)
|   ├── Primitives 
│   ├── Student
│   ├── Problem
│   ├── Submission
│   └── Academy
├── Plugins
├── Dependencies (Maven dependencies)
├── Judger (Force: Online Judge System)
│   ├── CC-Profiler-Sandbox
│   └── Code-Quality-Inspection (Submodule)
└── Spring-Boot (Force: Tech Stack)
    ├── Spring-Boot-Commons
    ├── Spring-Boot-Academy
    ├── Spring-Boot-Problem
    ├── Spring-Boot-Student
    └── Spring-Boot-Submission

with 100% respect to the following diagram from Uncle Bob:

Domain

In every domain package, there are application use cases (request + presenters), domain services and repositories. Every repository encapsulates the persistency of an aggregate root (e.g., Student/Problem/Submission) and every use case represents an application feature.

Tech Stack & System Architecture

Spring Boot is used to run our Judge Girl application.

Never write logs in the domain layer

We would log in technical layer (Controller, technical implementations, JPA, ...), but never in our domain layer. We use Aspect-Oriented Programming to inject logs into our domain layer.

Software Testing

Judge Girl is developed under E2E (API --> Database) test cases covering application usecases and Unit Test covering domain logic and utils. Where in our tests, RabbitMQ, MongoDB and MySQL are embedded.

code-quality-inspection's Issues

Replace the CC's testdata with a set of well-defined and classic testdata that reflexes our test intent

Description

We do not need a ton of test data to perform a very strict test,
we do only need a set of test data (maybe, ten) which can reflexes our test intent clearly.

For example:

a testdata given below

int main() {
    // No code
}

a code with no complexity may have a CC of zero?

This issue replace the testdata with the intentional ones.

Acceptance Criteria

No illegal naming style or global variable will cause java side error

Describe the bug
As title.

To Reproduce
Write a perfect code and analyze it (?)

Count global variable, check naming style in cppcheck part

Description

• Count number of global variable
  • Add test
• Count bad naming style variable
  • Add test

Acceptance Criteria

Remove XML from analyze, generate XML from main

Description

Remove building XML from analyze part.
The result object should be return to main and build by another thing(?)

Acceptance Criteria

Implement Cyclomatic Complexity Calculation algorithm

Description

Implement the cyclomatic complexity calculation algorithm.

Acceptance Criteria

80% Test Coverage with 3 different codes.

Integrate CppCheck's dump file from Python

Description

1. Feed source root's path to Java
2. Java calls python script with the source's root path
3. Python calls cppcheck and print the dump file

Acceptance Criteria

Regex to find out string literals might cause stack overflow.

Since Java uses recursion to implement regex matching, the regex of matching string literals might cause the depth of the recursion to be the length of the string length, which might cause stack overflow for a long string literals.
Change the method of finding string literals by using loops to avoid stack overflow.

Enrich coding style checking report content

Description

Add some method to return more information from coding style checking.

• What variable names violated naming style checking.
• What variables violated global variable checking.
• Maybe Generate a string from these information?
• Tests.

Acceptance Criteria

Change variable naming style rule

Description

Keep current rules but

1. reject single char name by default
2. reads another whitelist token array to accept these token

Questions

• How to receive tokens?
• If whitelist is for token and we enable i, j, k:
  • i_j_k or jIK are valid.
• If whitelist is for variable:
  • aGoodVariable will not be valid since a is rejected.

Acceptance Criteria