ENRE

ENRE (ENtity Relationship Extractor ) is a tool for extraction of code entity dependencies(relationships) from source code. The resolved dependency types include:

Dependency Type	Description
Import	a File imports a Package, Module, etc.
Implement	A Class implements an Interface.
Extend	A Class inherits a Class.
Call	A function/Method calls A Function/method.
Use	A Function/Method uses or reads a Variable.
Set	A Function/Method uses or reads a Varibale.
Parameter	A Funciton/Method has a Class type parameter.
Return	A Function/Method returns a Class type value.

Features

Basic Feature

ENRE supports analyzing source code written in Python, Go.

Advanced Feature

New Update!

ENRE has integrated type inference technique and type stub files (one of type hint practices) to enhance the extraction of Possible Dependencies in Python code.

Possible Dependencies are the syntactic dependencies indiscernible in source code due to the lack of explicit type references, in contrast with Explicit Dependencies.

You can learn more about this fresh feature and experience it by diving into the ENRE-v2.0.

Features under development

We are improving ENRE to support analyzing JAVA and CPP languages. We are also updating ENRE-python by using Python AST library. We plan to publish these features at the end of 2022 YEAR.

Usage

1)Prepare the executable jar

The released jar of ENRE is named as ENRE-v1.0.jar.

2) Set up Java environment

To execute ENRE-v1.0.jar, you should set up JAVA envionment. Please referer to Set up JAVA environment.

3) cmd usage

Now, everthing is already prepared well. Let's use ENRE to analyze source code. The usage command is:

java -jar <executable> <lang> <dir> <include-dir> <project-name>

<executable>. The executable jar package of ENRE.
<lang>. The language of source code that will be analyzed. It can be python or golang.
<dir>. The path of the source code that will be analyzed.
<include-dir>. The github url of source code. It only works when analyzing golang projects. Set it "null" when analyzing python projects.
<project-name>. A short alias name of the anayzed source code project.

Example I:

Use ENRE to analyze a demo project "fire" written in Python:

#in linux platform 
$java -jar ENRE-v1.0.jar  python  demo-projects/fire   null  fire

#in windows platform
$java -jar ENRE-v1.0.jar  python  demo-projects\fire   null  fire

After analysis, ENRE finally outputs the resovled entities and dependencies in JSON, XML, DOT files in new-generated fire-out/ directory.

Example II:

Use ENRE to analyze a demo project "beego" written in Go:

#in linux platform 
$java -jar ENRE-v1.0.jar  golang  demo-projects/beego   github.com/astaxie/beego  beego

#in windows platform
$java -jar ENRE-v1.0.jar  golang  demo-projects\beego   github.com/astaxie/beego  beego

After analysis, ENRE finally outputs the resovled entities and dependencies in JSON, XML, DOT files in new-generated beego-out/ directory.

After v2.0, ENRE can selectively output all entities rather than file-level entities. For that target, you should change your input message.

$args: golang demo-projects/beego github.com/astaxie/beego beego 111111111 11/01/10

For the above parameters explained, "111111111" orders ENRE to analyze all dependency types and "11" can order ENRE to output the file-level entities and all entities, "10" can order ENRE to output the file-level entities but not all entities.

notes: _entity.json, all entity information is stored. _dep.json, all file-level entity information is stored.

References

You can reference the following papers if you use ENRE or want to learn more about it.

@inproceedings{2020ase-jin,
    title={Exploring the Architectural Impact of Possible Dependencies in Python Software},
	
    author={Jin, Wuxia and Cai, Yuanfang and Kazman, Rick and Zhang, Gang and Zheng, Qinghua and Liu, Ting},
    booktitle={2020 35th IEEE/ACM International Conference on Automated Software Engineering (ASE)},
    pages={1--13},
    year={2020},
    organization={IEEE}
    }

@inproceedings{2019icse-jin,
  title={ENRE: a tool framework for extensible eNtity relation extraction},
  
  author={Jin, Wuxia and Cai, Yuanfang and Kazman, Rick and Zheng, Qinghua and Cui, Di and Liu, Ting},
  booktitle={Proceedings of the 41st International Conference on Software Engineering: Companion Proceedings},
  pages={67--70},
  year={2019},
  organization={IEEE Press}
}

ENRE Introduction Video

License

MIT

xjtu-enre/ENRE-go-python