sugarcrm/tidbit

Random data generator for Sugar

Thursday, July 19, 2018
by mmarum-sugarcrm
Repository
104 Watchers
33 Stars
121 Installations

PHP
0 Dependents
0 Suggesters
44 Forks
12 Open issues
21 Versions
32 % Grown

The README.md

Tidbit v3.0 (bleeding edge) -- Tidbit v2.0 (stable)

Master	Develop
	![Build status][Develop image]
![Coverage Status][Master coverage image]	![Coverage Status][Develop coverage image]

Tidbit is random data generator for Sugar versions 7.8 and later. By optimizing the communications with the database, large amounts of data can be inserted into the system for testing without manual intervention., _(*1)

Documentation in the wiki!

Please visit the wiki for detailed documentation on using and configuring Tidbit., _(*2)

Requirements

PHP 5.6+ Sugar Already installed (7.8+ versions), _(*3)

Installation

To install Tidbit, unpack the Tidbit-v###.tar.bz2 file, and place the Tidbit/ directory within your SugarCRM installation (Tidbit Directory need to be created inside SugarCRM Installation folder)., _(*4)

Download composer, _(*5)

curl -sS https://getcomposer.org/installer | php

Install composer dependencies inside Tidbit directory, _(*6)

./composer.phar install

The only other requirement of Tidbit is that you have an installed and properly configured copy of Sugar in the directory above it., _(*7)

Installation of Vagrant Stack (Example):

SSH into vagrant stack you are using via command line., _(*8)
```
$ vagrant ssh
```

Navigate to Sugar directory., _(*9)

$ cd /
$ cd var/www/html/ (sugar instance).

Download zip file from repo (master.zip) into the sugar instance. e.g. /SugarEnt-Full-7.6.0.0/., _(*10)
```
$ wget (url to zip file)
```
Unzip file (master.zip). Directory created by zip file is called Tidbit-master., _(*11)
```
$ unzip master.zip
```
Change Directory to /Tidbit e.g., mv /Tidbit-master /Tidbit., _(*12)
```
$ mv /Tidbit-master /Tidbit
```
Navigate to /Tidbit and follow instructions under usage, below, from within /Tidbit directory., _(*13)
```
$ cd /Tidbit
```
Install Composer dependencies, _(*14)
```
$ ./composer.phar install
```

Configuration

Tidbit has default config files in tidbit_root/config/ folder.
Here:
    - config.php          -- main config file
    - data/*.php          -- customization of filling for separate fields if
                             bean tables
    - relationships/*.php -- customization of filling for separate fields if
                             bean relation tables
Tidbit settings can be fully overrided in tidbit_root/custom/config.php file
by php arrays in the same manner as in original configs

Usage

NOTES:, _(*15)

Usage of Tidbit could affect your data in DB Please make sure you have a backup, before running data Generation commands, _(*16)
In case of generation csv (--storage csv) We suppose what csv-dump will be used on empty DB, so for speed up, we'll generate values (integer starting with 1) for autoincrement-type fields., _(*17)

Tidbit uses a command line interface. To run it from the Tidbit directory:, _(*18)

$ ./bin/tidbit (or ./vendor/bin/tidbit for package dependency installation)

Various options are available to control the number of entries generated. To view them:, _(*19)

$ ./bin/tidbit -h

Example usages:, _(*20)

* Clean out existing seed data when generating new data set:
  $ ./bin/tidbit -c

* Insert 500 users:
  $ ./bin/tidbit -u 500

* Generate data into csv (mysql is default):
  $ ./bin/tidbit --storage csv

* Generate records for all out-of-box and custom modules, plus find all relationships
  $ ./bin/tidbit --allmodules --allrelationships

* Obliterate all data when generating new records with 400 users:
  $ ./bin/tidbit -o -u 400

* Use profile (pre-existing one: simple, simple_rev2, average, high) file to generate data
  $ ./bin/tidbit -o --profile simple --sugar_path /some/sugar/path

* Use custom profile (located in /path/to/profile/file)
  $ ./bin/tidbit -o --profile /path/to/profile --sugar_path /some/sugar/path

* Generate TeamBasedACL action restrictions for chosen level (check level options in config files)
  $ ./bin/tidbit -o --tba -tba_level full

* Controlling INSERT_BATCH_SIZE (MySQL Support only for now)
  $ ./bin/tidbit -o --insert_batch_size 1000

* Setting path to SugarCRM installation
  $ ./bin/tidbit -o --sugar_path /some/sugar/path

* Using DB2 storage example (mysql/oracle/db2 can be used, depending on Sugar installation and DB usage)
  $ ./bin/tidbit -o --sugar_path /some/sugar/path --storage db2

Contributing:

See CONTRIBUTING for how you can contribute changes back into this project., _(*21)

All Pull Requests should be targeted to "develop" branch and follow PSR2 Code Style Standard To run quick code check use, _(*22)

$ ./composer.phar check-style

or call PHP CS directly, _(*23)

$ ./vendor/bin/phpcs --standard=./ruleset.xml

to run PHPUnit tests locally please use, _(*24)

$ ./composer.phar tests

or call PHPUnit directly, _(*25)

$ ./vendor/bin/phpunit -c ./phpunit.xml.dist

There are automated PR checks enabled on TravisCI (https://travis-ci.org/sugarcrm/Tidbit) For each PR code-style and phpunit tests will be executed for verification, _(*26)

The Versions

19/07 2018

dev-develop

dev-develop https://github.com/sugarcrm/tidbit

Random data generator for Sugar

library tidbit

Random data generator for Sugar

sugarcrm/tidbit

The README.md

Tidbit v3.0 (bleeding edge) -- Tidbit v2.0 (stable)

Documentation in the wiki!

Requirements

Installation

Installation of Vagrant Stack (Example):

Configuration

Usage

Contributing:

The Versions

dev-develop

The Requires

The Development Requires

by SugarCRM

dev-team_name_incname

The Requires

The Development Requires

by SugarCRM

dev-fix_priv_team_name_2

The Requires

The Development Requires

by SugarCRM

dev-parallel_csv

The Requires

The Development Requires

by SugarCRM

dev-empty_descriptio

The Requires

The Development Requires

by SugarCRM

dev-parallel

The Requires

The Development Requires

by SugarCRM

dev-no_counters_in_rel_id

The Requires

The Development Requires

by SugarCRM

dev-get_rid_of_as_for_good

The Requires

The Development Requires

by SugarCRM

dev-generate_tags_always

The Requires

The Development Requires

by SugarCRM

dev-rewrite_favorites

The Requires

The Development Requires

by SugarCRM

dev-simplify_rel_id_calc

The Requires

The Development Requires

by SugarCRM

dev-redo_rel_multiplier

The Requires

The Development Requires

by SugarCRM

dev-skip_total_0

The Requires

The Development Requires

by SugarCRM

dev-erased_fields

The Requires

The Development Requires

by SugarCRM

dev-master

The Requires

The Development Requires

by SugarCRM

dev-precalculate_field_rules

The Requires

The Development Requires

by SugarCRM

dev-fix_division_by_zero

The Requires

The Development Requires