|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+=====
|
|
|
2
|
+Usage
|
|
|
3
|
+=====
|
|
|
4
|
+
|
|
|
5
|
+DB Setup
|
|
|
6
|
+--------
|
|
|
7
|
+
|
|
|
8
|
+The usage of coverage2sql is split into 2 stages. First you need to prepare a
|
|
|
9
|
+database with the proper schema; coverage2sql-db-manage should be used to do
|
|
|
10
|
+this. The utility requires db connection info which can be specified with a
|
|
|
11
|
+config file. Obviously the sql connector type, user,
|
|
|
12
|
+password, address, and database name should be specific to your environment.
|
|
|
13
|
+coverage2sql-db-manage will use alembic to setup the db schema. You can run the
|
|
|
14
|
+db migrations with a config file::
|
|
|
15
|
+
|
|
|
16
|
+ coverage2sql-db-manage --config-file etc/coverage2sql.conf upgrade head
|
|
|
17
|
+
|
|
|
18
|
+This will bring the DB schema up to the latest version for coverage2sql.
|
|
|
19
|
+
|
|
|
20
|
+.. _coverage2sql:
|
|
|
21
|
+
|
|
|
22
|
+coverage2sql
|
|
|
23
|
+------------
|
|
|
24
|
+
|
|
|
25
|
+Once you have a database setup with the proper database schema you can then use
|
|
|
26
|
+the coverage2sql command to populate the database with data from your test
|
|
|
27
|
+coverage file. coverage2sql takes in a `.coverage file`_ through by passing it
|
|
|
28
|
+file paths as positional arguments to the script at this moment.
|
|
|
29
|
+
|
|
|
30
|
+.. _.coverage file: http://coverage.readthedocs.io/en/latest/cmd.html#data-file
|
|
|
31
|
+
|
|
|
32
|
+There are several options for running coverage2sql, they can be listed with::
|
|
|
33
|
+
|
|
|
34
|
+ coverage2sql --help
|
|
|
35
|
+
|
|
|
36
|
+The only required option is --database-connection. The options can either be
|
|
|
37
|
+used on the CLI, or put in a config file. If a config file is used you need to
|
|
|
38
|
+specify the location on the CLI.
|
|
|
39
|
+
|
|
|
40
|
+Using in project
|
|
|
41
|
+----------------
|
|
|
42
|
+
|
|
|
43
|
+To use coverage2sql in a project::
|
|
|
44
|
+
|
|
|
45
|
+ import coverage2sql
|
|
|
46
|
+
|
|
|
47
|
+TODO
|
|
|
48
|
+----
|
|
|
49
|
+
|
|
|
50
|
+To see the TODO, go to the launchpad site:
|
|
|
51
|
+
|
|
|
52
|
+* `https://bugs.launchpad.net/coverage2sql <https://bugs.launchpad.net/coverage2sql>`_
|
|
|
53
|
+* `https://blueprints.launchpad.net/coverage2sql <https://blueprints.launchpad.net/coverage2sql>`_
|
|
|
54
|
+
|
|
|
55
|
+ChangeLog
|
|
|
56
|
+---------
|
|
|
57
|
+
|
|
|
58
|
+To see the release notes go here: `http://docs.openstack.org/releasenotes/coverage2sql/ <http://docs.openstack.org/releasenotes/coverage2sql/>`_
|
Dong Ma
1 year ago