Skip to content

Commit 3f26833

Browse files
committed
fix requested from review
1 parent 3d283d7 commit 3f26833

File tree

2 files changed

+23
-24
lines changed

2 files changed

+23
-24
lines changed

docs/OverallArchitecture.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -129,12 +129,12 @@ TODO (Nikita Stroganov)
129129
TODO (Nikita Stroganov)
130130

131131
### Contest estimator
132-
The main responsibility of Contest estimator is running UTBot on prepared projects in advance and providing some statistics such as instruction coverage.
132+
Contest estimator runs UnitTestBot on the provided projects and returns the generation statistics such as instruction coverage.
133133

134-
It is placed in [utbot-junit-contest][contest estimator 1] module and has several entry points:
135-
- [ContestEstimator.kt][contest estimator 2] - the main entry point of Contest estimator, it runs UTBot on specified projects, calculates some statistics for target classes and projects and outputs them in a console.
136-
- [StatisticsMonitoring.kt][contest estimator 3] - an additional entry point of Contest estimator which does the same as the previous one, but can be configured from a file and dumps output statistics to a file.
137-
It is used to [monitor and chart][contest estimator 4] statistics every night.
134+
Contest estimator is placed in the [utbot-junit-contest][contest estimator 1] module and has two entry points:
135+
- [ContestEstimator.kt][contest estimator 2] is the main entry point. It runs UnitTestBot on the specified projects, calculates statistics for the target classes and projects, and outputs them to a console.
136+
- [StatisticsMonitoring.kt][contest estimator 3] is an additional entry point, which does the same as the previous one but can be configured from a file and dumps the resulting statistics to a file.
137+
It is used to [monitor and chart][contest estimator 4] statistics nightly.
138138

139139
[contest estimator 1]: ../utbot-junit-contest
140140
[contest estimator 2]: ../utbot-junit-contest/src/main/kotlin/org/utbot/contest/ContestEstimator.kt

utbot-junit-contest/README.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Contest Estimator
1+
# Contest estimator
22

3-
The main responsibility of Contest estimator is running UTBot on prepared projects in advance and providing some statistics such as instruction coverage.
3+
Contest estimator runs UnitTestBot on the provided projects and returns the generation statistics such as instruction coverage.
44

5-
There are several entry points:
6-
- [ContestEstimator.kt][ep 1] - the main entry point of Contest estimator, it runs UTBot on specified projects, calculates some statistics for target classes and projects and outputs them in a console.
7-
- [StatisticsMonitoring.kt][ep 2] - an additional entry point of Contest estimator which does the same as the previous one, but can be configured from a file and dumps output statistics to a file.
8-
It is used to [monitor and chart][monitoring] statistics every night.
5+
There are two entry points:
6+
- [ContestEstimator.kt][ep 1] is the main entry point. It runs UnitTestBot on the specified projects, calculates statistics for the target classes and projects, and outputs them to a console.
7+
- [StatisticsMonitoring.kt][ep 2] is an additional entry point, which does the same as the previous one but can be configured from a file and dumps the resulting statistics to a file.
8+
It is used to [monitor and chart][monitoring] statistics nightly.
99

1010

1111
[ep 1]: src/main/kotlin/org/utbot/contest/ContestEstimator.kt
@@ -14,32 +14,31 @@ It is used to [monitor and chart][monitoring] statistics every night.
1414

1515
## Key functions
1616

17-
| Function name | File name | Description |
18-
|---------------|---------------------|-----------------------------------------------------------------------------------------------------------|
19-
| runGeneration | Contest.kt | This function runs UTBot and manage it's work |
20-
| runEstimator | ContestEstimator.kt | This function configure a project's classpath and does main loop of generation with collection statistics |
17+
| Function name | File name | Description |
18+
|---------------|---------------------|----------------------------------------------------------------------------------------|
19+
| runGeneration | Contest.kt | Runs UnitTestBot and manages its work |
20+
| runEstimator | ContestEstimator.kt | Configures a project classpath, runs the main generation loop, and collects statistics |
2121

2222

2323
## Projects
2424

25-
There are some prepared projects in advance.
25+
The projects are provided to Contest estimator in advance.
2626

2727
### Structure
28-
All available projects are placed in [resources][resources] folder.
29-
There are two folders:
30-
- [projects][projects] - consists of folders with projects' jar files.
31-
- [classes][classes] - consists of folders which are named as projects and contains `list` file with a list of fully qualified names of classes.
28+
All available projects are placed in the [resources][resources] folder, which contains:
29+
- [projects][projects] consisting of the folders with the project JAR files in them.
30+
- [classes][classes] consisting of the folders — each named after the project and containing the `list` file with the fully qualified class names.
3231

33-
### How to add a new project?
34-
You can add jar files to the `projects` folder described above, and also add `list` file with a list of classes that will be provided to generation.
32+
### How to add a new project
33+
You should add both the JAR files to the `projects` folder and the file with a list of classes to the `classes` folder.
3534

3635
[resources]: src/main/resources
3736
[projects]: src/main/resources/projects
3837
[classes]: src/main/resources/classes
3938

4039
## Statistics
41-
Now statistics are collected and memorised by some classes placed in [Statistics.kt][statistics].
42-
Then [monitoring][ep 2] dumps them using auxiliary classes defined in [MonitoringReport.kt][report] which describe format of output data.
40+
Statistics are collected and memorized by the corresponding classes placed in [Statistics.kt][statistics].
41+
Then [monitoring][ep 2] dumps them using auxiliary classes that are defined in [MonitoringReport.kt][report] — they describe the format of output data.
4342

4443
[statistics]: src/main/kotlin/org/utbot/contest/Statistics.kt
4544
[report]: src/main/kotlin/org/utbot/monitoring/MonitoringReport.kt

0 commit comments

Comments
 (0)