Skip to content

Latest commit

 

History

History
108 lines (66 loc) · 3.36 KB

README.md

File metadata and controls

108 lines (66 loc) · 3.36 KB
Raw

billsourcery

A tool for analysing the source code of Equinox applications.

Requirements

Installation

go install github.com/utilitywarehouse/billsourcery@latest

Usage

billsourcery --help

Neo4j graph database

If using the neo4j output from billsourcery, you may wish to install and use neo4j.

Neo4J Installation

Download and install Neo4j

For simple local use, disable authentication by setting dbms.security.auth_enabled=false in neo4j.conf

Load analysed bill source code data into neo4j

This may take some time to import (e.g. 10 or 20 minutes)

$ cd && git clone [email protected]:utilitywarehouse/uw-bill-source-history.git
$ billsourcery --source-root=${PATH_TO_BILL_SOURCE} generate-graph --output-type neo | cypher-shell

alternatively, if you also want usage information, first obtain CSVs of the ModuleS and ModuDet tables from Bill using eqdb-loader, and then use :

$ billsourcery --source-root=${PATH_TO_BILL_SOURCE} generate-graph --output-type neo --modules-csv /path/to/ModuleS.csv --modudet-csv /path/to/ModuDet.csv  | cypher-shell

Visualise graph data (example queries)

Navigate to http://localhost:7474/

Find missing nodes that are referenced from elsewhere:

`MATCH (n:Missing) return n`

Find nodes containing the name "customer":

`MATCH (n:Node) where n.name CONTAINS 'customer' return n`

Find methods that are not called from anywhere:

`MATCH (m:Method) WHERE NOT (m)<-[:references]-() RETURN m.name order by m.name`

Find method nrg_sweep2 and everything it references, recursively. Exclude fields and work areas for clarity:

`MATCH p=(n:Node)-[r:references*]->(x:Node) where lower(n.name)="nrg_sweep2" and not(x:Field) and not(x:WorkArea) RETURN p`

Find table ginv and everything that references it, recursively.

`MATCH p=(n:Node)-[r:references*]->(x:Table) where lower(x.name)="ginv" RETURN p`

A variation on the above, find everything that references ginv, excluding fields and indexes for clarity (tables accessed via indexes will still be included:

MATCH path = ()-[*]->(t:Table)
WHERE NONE(n IN nodes(path) WHERE (n:Field or n:Index))
and lower(t.name) = "ginv"
RETURN path

Find the most referenced tables:

`MATCH (n)-[references]->(t:Table) RETURN  t.name, count(n) order by count(n) desc limit 20`

Find unreferenced fields on tables that are marked as Used:

`MATCH (f:Field)-[:references]->(t:Table:Used) WHERE NOT (f)<-[:references]-() RETURN t.name, f.name order by t.name, f.name`

Find unused indexes on tables that are used:

`MATCH (i:Index)-[:references]->(t:Table:Used) WHERE NOT (i)<-[:references]-() RETURN t.name, i.name order by t.name, i.name`

Find unreferenced tables:

MATCH (n:Table)
where not exists {
  match (n:Table)<-[r:references]-(m) where NOT m:Index and NOT m:Field AND r IS NOT NULL
}
RETURN distinct n

Find everything GENIENEW references (directly or indirectly) excluding fields and indexes:

MATCH path = (m:Node)-[*]->(t:Table)
WHERE NONE(n IN nodes(path) WHERE (n:Field or n:Index))
and lower(m.name) = "genienew"
RETURN path

Find everything that references pesrates (directly or indirectly) excluding fields and indexes:

MATCH p=(n:Node)-[r:references*]->(x:Node)
WHERE NONE(n IN nodes(p) WHERE (n:Field or n:Index))
and lower(x.name)="pesrates" RETURN p