Skip to content

Commit de8904d

Browse files
authored
Update README.md
1 parent e98dd56 commit de8904d

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

+23-23
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Smith
22

3-
Smith is a service that allows to run integrational long running tests in parallel in a serverless cloud.
3+
Smith is a service that allows to run integrational long-running tests in parallel in a serverless cloud.
44

55
Cloudformation templete will create AWS serverless resources - SQS, S3 buckets, ECS sevice, Api Gateway and VPC.
66

7-
API allows to pass tests you want to execute. Smith will spawn ECS instances, execute tests, store logs in S3, send results to SQS and stop ECS instances.
7+
API allows to specify tests you want to execute. Smith will spawn ECS instances, execute tests, store logs in S3, send results to SQS and stop ECS instances.
88

99
This allows to run as many tests as you want in parallel without the need of keeping long-running agent instances. Smith will manage resources for you and spawn servers for the execution time only.
1010

@@ -29,10 +29,10 @@ smith-reports-[REGION]-[ACCOUNT_ID] S3 bucket
2929
Corresponding messages will be sent to smith-results SQS so you could consume results
3030

3131
## Supported tests
32-
At this point Smith supports Maven Junit tests only. We work hard to bring in Gradle, Nunit, Pytest (and may othere) support.
32+
At this point Smith supports Maven Junit tests only. We work hard to bring in Gradle, NUnit, Pytest (and may othere) support.
3333

3434
## Maven Junit
35-
To make Smuth execute your tests it should have access to them.
35+
To make Smith execute your tests it should have access to them.
3636

3737
1. First you'll have to pack and deploy your tests as jars.
3838
In order to do that - add the following plugin to your tests:
@@ -52,24 +52,9 @@ In order to do that - add the following plugin to your tests:
5252
</plugin>
5353
```
5454

55-
and add distributeion management pointing to S3 buckets created by Cloud Formation Template
56-
57-
```
58-
<distributionManagement>
59-
<snapshotRepository>
60-
<id>my-repo-bucket-snapshot</id>
61-
<url>s3://smith-artifacts-snapshot-[REGION]-[ACCOUNT_ID]</url>
62-
</snapshotRepository>
63-
<repository>
64-
<id>my-repo-bucket-release</id>
65-
<url>s3://smith-artifacts-release-[REGION]-[ACCOUNT_ID]</url>
66-
</repository>
67-
</distributionManagement>
68-
```
69-
7055
2. Your tests should be available to Smith. Here you have 3 optioms:
7156

72-
* Your tests are available in Maven Central. Doubtfully it will be the case but if so - you don't need to do anything more
57+
* Your tests are available in Maven Central. Doubtfully it will be the case but if so - you don't need to do anything else
7358

7459
* You can upload your test to the S3 bucket created by Smith Cloud Formation Template. To do that you have to add the following extension to your project in a Build section:
7560

@@ -106,18 +91,33 @@ Add AWS credentials to your ~/.m2/settings.xml file:
10691
</server>
10792
```
10893

109-
* Another way is to put your maven settings.xml file into "smith-private-settings-[REGION]-[ACCOUNT_ID]" bucket created by the template. If Smith will find settings.xml there - it will use it.
94+
and add distributeion management pointing to S3 buckets created by Cloud Formation Template
95+
96+
```
97+
<distributionManagement>
98+
<snapshotRepository>
99+
<id>my-repo-bucket-snapshot</id>
100+
<url>s3://smith-artifacts-snapshot-[REGION]-[ACCOUNT_ID]</url>
101+
</snapshotRepository>
102+
<repository>
103+
<id>my-repo-bucket-release</id>
104+
<url>s3://smith-artifacts-release-[REGION]-[ACCOUNT_ID]</url>
105+
</repository>
106+
</distributionManagement>
107+
```
108+
109+
* Another way is to put your maven settings.xml file into "smith-private-settings-[REGION]-[ACCOUNT_ID]" bucket created by the template. If Smith will find settings.xml there (in the root) - it will use it.
110110
In settings.xml you can specify alternative path to your maven repository
111111

112112
## Deploy
113113
Deploy your tests using
114114
mvn clean deploy
115115

116116
## Run
117-
Thats it. Run your tests using API with the data format above.
117+
Run your tests using API-call with the data format shown above.
118118

119119
But the easiest way is to run tests through QuAck (testquack.com).
120-
QuAck allows you to import tests into the system and features Smith Runner. Smith Runner is a plugin that allows to run tests througb QuAck UI in Smith and get and store results.
120+
QuAck allows you to import tests into the system and features Smith Runner. Smith Runner is a plugin that allows to run tests througb QuAck UI in Smith, get and store results.
121121

122122
## Example
123123
Here you'll find tests examples that are being uploaded to QuAck and Smith. This allows using Smith Launher plugin in QuAck to run tests and store results in QuAck.

0 commit comments

Comments
 (0)