Skip to content

Commit 01ca5bc

Browse files
authored
Merge pull request #389 from NielsFeldtmannKALO/update_readme_own_build
refactor: improvements to README.md
2 parents b40753e + 30c6761 commit 01ca5bc

File tree

1 file changed

+58
-53
lines changed

1 file changed

+58
-53
lines changed

README.md

Lines changed: 58 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -15,59 +15,63 @@
1515

1616
# rapiddweller-benerator-ce
1717

18-
Welcome to [rapiddweller Benerator](https://www.benerator.de), a powerful software solution for data generation, obfuscation, and migration for development, testing, and training purposes. Our core goals are to provide model-driven test data generation that satisfies complex data validity requirements, anonymize production data for showcases and serious performance testing projects, efficiently generate large data volumes, and offer wide customizability and ease of use for non-developers.
18+
Welcome to [rapiddweller Benerator](https://www.benerator.de), a powerful
19+
software solution for data generation, obfuscation, and migration for
20+
development, testing, and training purposes.
21+
Our core goals are to provide model-driven test data generation that
22+
satisfies complex data validity requirements, anonymize production data for
23+
showcases and serious performance testing projects, efficiently generate large
24+
data volumes, and offer wide customization possibilities and ease of use for
25+
non-developers.
1926

2027
## Quickstart ( use benerator version from releases )
2128

2229
1. make sure you have installed **Java 11 JDK** or higher and **JAVA_HOME** environment variable is set correctly
2330
2. download the latest benerator version from [Releases](https://github.com/rapiddweller/rapiddweller-benerator-ce/releases)
2431
3. unzip .tar.gz to *choose/your/path*
25-
4. open a terminal (bash / PowerShell) and add environment variable BENERATOR_HOME=*choose/your/path* and add *choose/your/path*/bin to your PATH variable
32+
4. add environment variable BENERATOR_HOME=*choose/your/path* and add *choose/your/path*/bin to your PATH variable
2633
For example **(these environment variables are only set in your terminal session, read more about environment variables [here](https://en.wikipedia.org/wiki/Environment_variable))**
2734

28-
#### Linux bash
29-
```shell
30-
export BENERATOR_HOME=/home/user1/rapiddweller-benerator-ce-3.1.0-jdk-11-dist
31-
export PATH=$BENERATOR_HOME/bin:$PATH
32-
chmod a+x $BENERATOR_HOME/bin/*.sh
33-
```
34-
#### Mac
35-
36-
Install with Homebrew
37-
Link to Homebrew Formular [here](https://formulae.brew.sh/formula/benerator)
38-
39-
```shell
40-
brew install benerator
41-
```
42-
43-
#### Windows 10 PowerShell
44-
```powershell
45-
$env:BENERATOR_HOME='C:\Users\user1\rapiddweller-benerator-ce-3.1.0-jdk-11-dist'
46-
$env:Path += 'C:\Users\user1\rapiddweller-benerator-ce-3.1.0-jdk-11-dist\bin'
47-
```
48-
35+
* Linux bash
36+
```shell
37+
export BENERATOR_HOME=/home/user1/rapiddweller-benerator-ce-3.1.0-jdk-11-dist
38+
export PATH=$BENERATOR_HOME/bin:$PATH
39+
chmod a+x $BENERATOR_HOME/bin/*.sh
40+
```
41+
* Mac
42+
Install with Homebrew
43+
Link to Homebrew Formular [here](https://formulae.brew.sh/formula/benerator)
44+
```shell
45+
brew install benerator
46+
```
47+
* Windows 10 PowerShell
48+
```powershell
49+
$env:BENERATOR_HOME='C:\Users\user1\rapiddweller-benerator-ce-3.1.0-jdk-11-dist'
50+
$env:Path += 'C:\Users\user1\rapiddweller-benerator-ce-3.1.0-jdk-11-dist\bin'
51+
```
52+
4953
5. create your own benerator script myscript.xml with the following content
50-
```xml
51-
<setup>
52-
<import domains="person,organization"/>
53-
<generate type="customer" count="1000" threads="1" consumer="LoggingConsumer,CSVEntityExporter">
54-
<variable name="person" generator="new PersonGenerator{minAgeYears='21', maxAgeYears='67',femaleQuota='0.5'}" />
55-
<variable name="company" generator="CompanyNameGenerator" />
56-
<attribute name="first_name" script="person.familyName" />
57-
<attribute name="last_name" script="person.givenName" />
58-
<attribute name="birthDate" script="person.birthDate" converter="new java.text.SimpleDateFormat('dd.MM.YYYY')" />
59-
<attribute name="superuser" values="true, false" />
60-
<attribute name="salutation" script="person.salutation " />
61-
<attribute name="academicTitle" script="person.academicTitle" />
62-
<attribute name="email" script="'info@' + company.shortName.replace(' ', '-') + this.tc_creation + '.de'" />
63-
</generate>
64-
</setup>
65-
```
66-
54+
```xml
55+
<setup>
56+
<import domains="person,organization"/>
57+
<generate type="customer" count="1000" threads="1" consumer="LoggingConsumer,CSVEntityExporter">
58+
<variable name="person" generator="new PersonGenerator{minAgeYears='21', maxAgeYears='67',femaleQuota='0.5'}" />
59+
<variable name="company" generator="CompanyNameGenerator" />
60+
<attribute name="first_name" script="person.familyName" />
61+
<attribute name="last_name" script="person.givenName" />
62+
<attribute name="birthDate" script="person.birthDate" converter="new java.text.SimpleDateFormat('dd.MM.YYYY')" />
63+
<attribute name="superuser" values="true, false" />
64+
<attribute name="salutation" script="person.salutation " />
65+
<attribute name="academicTitle" script="person.academicTitle" />
66+
<attribute name="email" script="'info@' + company.shortName.replace(' ', '-') + this.tc_creation + '.de'" />
67+
</generate>
68+
</setup>
69+
```
70+
6771
6. run your first benerator script
68-
```powershell
69-
benerator myscript.xml
70-
```
72+
```powershell
73+
benerator myscript.xml
74+
```
7175

7276
And that's it! You're ready to start using rapiddweller Benerator CE. We hope you find it as useful as we do. If you have any questions, please reach out to us on GitHub or visit our website www.benerator.de for more information.
7377

@@ -83,20 +87,20 @@ Please note that these instructions are a basic guide to get you started with th
8387
- Anonymization of production data for showcases and serious performance testing projects
8488
- Efficient generation of large data volumes, scaling up to companies with billions of customers and Big Data projects
8589
- Early applicability in projects
86-
- Efficiency by creating reuseable and extendable data models
90+
- Efficiency by creating reusable and extendable data models
8791
- Low Code approach to have more transparency
8892
- Little maintenance effort with ongoing implementation through configuration by exception
89-
- Wide and easy customizability
93+
- Wide and easy customization possibilities
9094
- Applicability by non-developers
9195
- Intuitive data definition format
9296
- Satisfying stochastic requirements on data
9397
- Extraction and anonymization of production data
9498
- Supporting distributed and heterogeneous applications
9599
- Establishing a common data generation platform for different business domains and software systems
96100

97-
### Data Synthesization
101+
### Data Synthesis
98102
Performance test data can be completely synthesized. A basic setup can be imported e.g. from DbUnit files, CSV files and fixed column width files. A descriptor file configures how imported data should be processed and adds completely synthesized data. The processed or generated data finally is stored in the system under test.
99-
![Data Synthesization](https://github.com/rapiddweller/rapiddweller-benerator-ce/blob/development/doc/assets/grafik1.png)
103+
![Data Synthesis](https://github.com/rapiddweller/rapiddweller-benerator-ce/blob/development/doc/assets/grafik1.png)
100104

101105
### Production Data Anonymization
102106
Production data can be easily extracted from production systems. Tables can be imported unmodified, filtered, anonymized and converted.
@@ -132,13 +136,14 @@ mvn -version
132136
`/Developer/Applications` or `C:\Program Files\Development`.
133137

134138
b) Checkout repository and build your own rapiddweller-benerator-ce using
135-
maven command `mvn clean install`
136-
139+
maven commands `mvn clean install` followed by `mvn assembly:single`
140+
(now you have a packed distribution af the current development)
141+
137142
__Please note__: We highly recommend using option 1a and download our release packages to ease your start.
138143
If you clone our GitHub repository, there are no binaries included, and you need to build benerator yourself.
139-
Building benerator requires a proper java/maven setup on your system. Learn more in
144+
Building benerator requires a proper java/maven setup on your system. Learn more in [Chapter Prerequisites](#prerequisites).
140145

141-
3. Set **BENERATOR_HOME**
146+
2. Set **BENERATOR_HOME**
142147
Create an environment variable BENERATOR_HOME that points to the path you extracted Benerator to.
143148

144149
- Windows Details: Open the System Control Panel, choose Advanced Settings - Environment Variables. Choose New in the
@@ -148,11 +153,11 @@ mvn -version
148153
- Mac/Unix/Linux Details: Add an entry that points to Benerator,
149154
e.g.: `export BENERATOR_HOME=/Developer/Applications/rapiddweller-benerator-ce-3.1.0-jdk-11`
150155

151-
4. On Unix/Linux/Mac systems: **Set permissions**
156+
3. On Unix/Linux/Mac systems: **Set permissions**
152157
Open a shell on the installation's root directory and execute
153158
`chmod a+x bin/*.sh`
154159
155-
5. Mac OS X configuration **Set JAVA_HOME**
160+
4. Mac OS X configuration **Set JAVA_HOME**
156161
On Mac OS X you need to provide benerator with an explicit configuration of the JAVA_HOME path.
157162
See [http://developer.apple.com/qa/qa2001/qa1170.html](http://developer.apple.com/qa/qa2001/qa1170.html)
158163
for a good introduction to the OS X way of setting up Java. It is based on aliases

0 commit comments

Comments
 (0)