def learn(self, ignore_regex="^$", max_commits=None, method_granularity=False, parallel=True,
bits=None, generations=None):
configs = self.get_yaml_configs()
max_commits = self.configure_yaml(configs, max_commits)
extractor = GitExtractor(self.repo_path)
repo = extractor.extract(ignore_regex, max_commits, method_granularity, parallel)
solution = FeatureWeightLearner(repo, bits, generations).learn()
return solution
def analyze(self, ignore_regex="^$", max_commits=None, method_granularity=True, parallel=True):
""" Analyze commits.
Extracts commits and call an analyzer to output analytics.
Args:
ignore_regex: An optional string that is a regex pattern to ignore unnecessary files.
max_commits: An optional int that is the maximum number of commits to extract since the last one.
method_granularity: An optional boolean that enables extraction until the method granularity.
Returns:
A RepositoryAnalytics instance.
"""
configs = self.get_yaml_configs()
max_commits = self.configure_yaml(configs, max_commits)
extractor = GitExtractor(self.repo_path)
repo = extractor.extract(ignore_regex, max_commits, method_granularity, parallel)
analysis = SchwaAnalysis(repo)
analytics = analysis.analyze()
return analytics
def testExtraction(self):
code = """
package org.feup.meoarenacustomer.app;
import android.app.DownloadManager;
import com.loopj.android.http.*;
static class API {
static String getUrl() {
return url;
}
static void setUrl(String url) {
this.url = url;
}
private String url;
private final String PRODUCTION_URL = "http://neo.andrefreitas.pt:8081/api";
private static AsyncHttpClient client = new AsyncHttpClient();
static API(String url ){
this.url = url;
}
static API(){
this.url = PRODUCTION_URL;
}
static void login(String email, String password, AsyncHttpResponseHandler responseHandler){
RequestParams params = new RequestParams();
params.put("email", email);
params.put("password", password);
client.post(url + "/login", params, responseHandler);
}
static void register(String name, String email, String nif, String password, String ccNumber, String ccType, String ccValidity, AsyncHttpResponseHandler responseHandler){
RequestParams params = new RequestParams();
params.put("name", name);
params.put("email", email);
params.put("password", password);
params.put("nif", nif);
params.put("ccNumber", ccNumber);
params.put("ccType", ccType);
params.put("ccValidity", ccValidity);
client.post(url + "/customers", params, responseHandler);
}
static void getShows(AsyncHttpResponseHandler responseHandler) {
client.get(url + "/shows", responseHandler);
}
}
private class SOAPAPI{
private void login(String name){
params.put("email", email);
}
}"""
""" First Commit """
# Added API.java
file_path = os.path.join(self.temp_dir, "API.java")
f = open(file_path, "w")
f.write(code)
f.close()
self.repo.git.add(file_path)
# Added README.txt
file_path = os.path.join(self.temp_dir, "README.txt")
f = open(file_path, "w")
f.write("TODO: Write readme")
f.close()
self.repo.git.add(file_path)
self.repo.git.commit(m="First commit")
creation_timestamp = time.time()
code_b = """
package org.feup.meoarenacustomer.app;
import android.app.DownloadManager;
import com.loopj.android.http.*;
static class API {
static String getUrl() {
return url;
}
static void setUrl(String url) {
this.url = url;
}
private String url;
private final String PRODUCTION_URL = "http://neo.andrefreitas.pt:8081/api";
private static AsyncHttpClient client = new AsyncHttpClient();
static API(String url ){
this.url = url;
}
static API(){
this.url = PRODUCTION_URL;
}
// Modified method
static void login(String email, String password, AsyncHttpResponseHandler responseHandler){
RequestParams params = new RequestParams();
params.put("email", email);
client.post(url + "/login", params, responseHandler);
}
// Removed method register()
// Added method
static void recover(String name){
RequestParams params = new RequestParams();
params.put("name", name);
params.put("email", email);
}
// Added method
static void outputShows(AsyncHttpResponseHandler responseHandler) {
client.get(url + "/shows", responseHandler);
}
static void getShows(AsyncHttpResponseHandler responseHandler) {
client.get(url + "/shows", responseHandler);
}
}
private class JSONAPI{
private void recover(String name){
RequestParams params = new RequestParams();
params.put("name", name);
params.put("email", email);
}
}
"""
""" Second commit """
# Modified API.java
file_path = os.path.join(self.temp_dir, "API.java")
f = open(file_path, "w")
f.write(code_b)
f.close()
self.repo.git.add(file_path)
self.repo.git.commit(m="Second commit")
code = """/* CallingMethodsInSameClass.java
*
* illustrates how to call static methods a class
* from a method in the same class
*/
public class CallingMethodsInSameClass
{
public static void main(String[] args) {
printOne();
printOne();
printTwo();
}
public static void printOne() {
System.out.println("Hello World");
}
public static void printTwo() {
printOne();
printOne();
}
}"""
""" Third commit """
# Added CallingMethodsInSameClass.java
file_path = os.path.join(self.temp_dir, "CallingMethodsInSameClass.java")
f = open(file_path, "w")
f.write(code)
f.close()
self.repo.git.add(file_path)
# Modified README.txt
file_path = os.path.join(self.temp_dir, "README.txt")
f = open(file_path, "w")
f.write("AUTHORS: Peter Griffin - [email protected]")
f.close()
self.repo.git.add(file_path)
self.repo.git.commit(m="Third commit")
""" Fourth Commit """
# Deleted CallingMethodsInSameClass.java
file_path = os.path.join(self.temp_dir, "CallingMethodsInSameClass.java")
self.repo.git.rm(file_path)
# Renamed API.java to API2.java
file_path_a = os.path.join(self.temp_dir, "API.java")
file_path_b = os.path.join(self.temp_dir, "API2.java")
self.repo.git.mv(file_path_a, file_path_b)
self.repo.git.commit(m="Fourth commit")
""" Fifth Commit"""
# Modified README.txt
file_path = os.path.join(self.temp_dir, "README.txt")
f = open(file_path, "w")
f.write("AUTHORS: Peter Griffin and Louis Griffin")
f.close()
self.repo.git.add(file_path)
self.repo.git.commit(m="Fifth commit")
""" Sixth Commit"""
# Added ShadowTest.java
code = """public class ShadowTest {
public int x = 0;
class FirstLevel {
public int x = 1;
void methodInFirstLevel(int x) {
System.out.println("x = " + x);
System.out.println("this.x = " + this.x);
System.out.println("ShadowTest.this.x = " + ShadowTest.this.x);
}
}
public static void main(String... args) {
ShadowTest st = new ShadowTest();
ShadowTest.FirstLevel fl = st.new FirstLevel();
fl.methodInFirstLevel(23);
}
}"""
file_path = os.path.join(self.temp_dir, "ShadowTest.java")
f = open(file_path, "w")
f.write(code)
f.close()
self.repo.git.add(file_path)
self.repo.git.commit(m="Sixth commit")
""" Extract """
extractor = GitExtractor(self.temp_dir)
repository = extractor.extract(method_granularity=True, parallel=False)
""" Tests """
self.assertEqual(len(repository.commits), 5, msg="It should only extract commits related to code")
self.assertTrue(repository.begin_ts < creation_timestamp, msg="It should extract the timestamp of first commit")
# First commit
self.assertEqual(repository.commits[0].message, "First commit\n")
self.assertEqual(repository.commits[0].author, "*****@*****.**")
diffs = repository.commits[0].diffs
self.assertEqual(len(diffs), 10)
self.assertTrue(DiffFile(file_b="API.java", added=True) in diffs)
self.assertTrue(DiffClass(file_name="API.java", class_b="SOAPAPI", added=True) in diffs)
self.assertTrue(DiffClass(file_name="API.java", class_b="API", added=True) in diffs)
self.assertTrue(DiffMethod(file_name="API.java", class_name="API", method_b="getUrl", added=True) in diffs)
self.assertTrue(DiffMethod(file_name="API.java", class_name="API", method_b="setUrl", added=True) in diffs)
self.assertTrue(DiffMethod(file_name="API.java", class_name="API", method_b="API", added=True) in diffs)
self.assertTrue(DiffMethod(file_name="API.java", class_name="API", method_b="login", added=True) in diffs)
self.assertTrue(DiffMethod(file_name="API.java", class_name="API", method_b="register", added=True) in diffs)
self.assertTrue(DiffMethod(file_name="API.java", class_name="API", method_b="getShows", added=True) in diffs)
self.assertTrue(DiffMethod(file_name="API.java", class_name="SOAPAPI", method_b="login", added=True) in diffs)
# Second commit
self.assertEqual(repository.commits[1].message, "Second commit\n")
diffs = repository.commits[1].diffs
self.assertEqual(len(diffs), 10)
self.assertTrue(DiffFile(file_a="API.java", file_b="API.java", modified=True) in diffs)
self.assertTrue(
DiffClass("API.java", class_a="API", class_b="API", modified=True) in diffs,
msg="It should recognize modified classes",
)
self.assertTrue(
DiffMethod("API.java", class_name="API", method_a="login", method_b="login", modified=True) in diffs,
msg="It should recognize modified methods",
)
self.assertTrue(
DiffMethod("API.java", class_name="API", method_a="register", removed=True) in diffs,
msg="It should recognize removed methods",
)
self.assertTrue(
DiffMethod("API.java", class_name="API", method_b="recover", added=True) in diffs,
msg="It should recognize added methods",
)
self.assertTrue(
DiffMethod("API.java", class_name="API", method_b="outputShows", added=True) in diffs,
msg="It should recognize added methods",
)
self.assertTrue(
DiffClass("API.java", class_a="SOAPAPI", removed=True) in diffs, msg="It should recognize removed classes"
)
self.assertTrue(
DiffClass("API.java", class_b="JSONAPI", added=True) in diffs, msg="It should recognize added classes"
)
self.assertTrue(
DiffMethod("API.java", class_name="SOAPAPI", method_a="login", removed=True) in diffs,
msg="It should recognize removed methods",
)
self.assertTrue(
DiffMethod("API.java", class_name="JSONAPI", method_b="recover", added=True) in diffs,
msg="It should recognize added methods",
)
# Third commit
self.assertEqual(repository.commits[2].message, "Third commit\n")
diffs = repository.commits[2].diffs
self.assertEqual(len(diffs), 5)
self.assertTrue(DiffFile(file_b="CallingMethodsInSameClass.java", added=True) in diffs)
self.assertTrue(
DiffClass(file_name="CallingMethodsInSameClass.java", class_b="CallingMethodsInSameClass", added=True)
in diffs
)
self.assertTrue(
DiffMethod(
file_name="CallingMethodsInSameClass.java",
class_name="CallingMethodsInSameClass",
method_b="main",
added=True,
)
in diffs
)
self.assertTrue(
DiffMethod(
file_name="CallingMethodsInSameClass.java",
class_name="CallingMethodsInSameClass",
method_b="printOne",
added=True,
)
in diffs
)
self.assertTrue(
DiffMethod(
file_name="CallingMethodsInSameClass.java",
class_name="CallingMethodsInSameClass",
method_b="printTwo",
added=True,
)
in diffs
)
# Fourth commit
self.assertEqual(repository.commits[3].message, "Fourth commit\n")
diffs = repository.commits[3].diffs
self.assertEqual(len(diffs), 2)
self.assertTrue(DiffFile(file_a="API.java", file_b="API2.java", renamed=True) in diffs)
self.assertTrue(DiffFile(file_a="CallingMethodsInSameClass.java", removed=True) in diffs)
# Sixth commit
self.assertEqual(repository.commits[4].message, "Sixth commit\n")
diffs = repository.commits[4].diffs
self.assertEqual(len(diffs), 5)
self.assertTrue(DiffFile(file_b="ShadowTest.java", added=True) in diffs)
self.assertTrue(
DiffClass(file_name="ShadowTest.java", class_b="ShadowTest.FirstLevel", added=True) in diffs,
msg="It should recognize nested classes",
)
self.assertTrue(DiffClass(file_name="ShadowTest.java", class_b="ShadowTest", added=True) in diffs)
self.assertTrue(
DiffMethod(
file_name="ShadowTest.java",
class_name="ShadowTest.FirstLevel",
method_b="methodInFirstLevel",
added=True,
)
in diffs,
msg="It should recognize nested classes",
)
self.assertTrue(
DiffMethod(file_name="ShadowTest.java", class_name="ShadowTest", method_b="main", added=True) in diffs
)
def testExtraction(self):
code = """
package org.feup.meoarenacustomer.app;
import android.app.DownloadManager;
import com.loopj.android.http.*;
static class API {
static String getUrl() {
return url;
}
static void setUrl(String url) {
this.url = url;
}
private String url;
private final String PRODUCTION_URL = "http://neo.andrefreitas.pt:8081/api";
private static AsyncHttpClient client = new AsyncHttpClient();
static API(String url ){
this.url = url;
}
static API(){
this.url = PRODUCTION_URL;
}
static void login(String email, String password, AsyncHttpResponseHandler responseHandler){
RequestParams params = new RequestParams();
params.put("email", email);
params.put("password", password);
client.post(url + "/login", params, responseHandler);
}
static void register(String name, String email, String nif, String password, String ccNumber, String ccType, String ccValidity, AsyncHttpResponseHandler responseHandler){
RequestParams params = new RequestParams();
params.put("name", name);
params.put("email", email);
params.put("password", password);
params.put("nif", nif);
params.put("ccNumber", ccNumber);
params.put("ccType", ccType);
params.put("ccValidity", ccValidity);
client.post(url + "/customers", params, responseHandler);
}
static void getShows(AsyncHttpResponseHandler responseHandler) {
client.get(url + "/shows", responseHandler);
}
}
private class SOAPAPI{
private void login(String name){
params.put("email", email);
}
}"""
""" First Commit """
# Added API.java
file_path = os.path.join(self.temp_dir, "API.java")
f = open(file_path, "w")
f.write(code)
f.close()
self.repo.git.add(file_path)
# Added README.txt
file_path = os.path.join(self.temp_dir, "README.txt")
f = open(file_path, "w")
f.write("TODO: Write readme")
f.close()
self.repo.git.add(file_path)
self.repo.git.commit(m='First commit')
creation_timestamp = time.time()
code_b = """
package org.feup.meoarenacustomer.app;
import android.app.DownloadManager;
import com.loopj.android.http.*;
static class API {
static String getUrl() {
return url;
}
static void setUrl(String url) {
this.url = url;
}
private String url;
private final String PRODUCTION_URL = "http://neo.andrefreitas.pt:8081/api";
private static AsyncHttpClient client = new AsyncHttpClient();
static API(String url ){
this.url = url;
}
static API(){
this.url = PRODUCTION_URL;
}
// Modified method
static void login(String email, String password, AsyncHttpResponseHandler responseHandler){
RequestParams params = new RequestParams();
params.put("email", email);
client.post(url + "/login", params, responseHandler);
}
// Removed method register()
// Added method
static void recover(String name){
RequestParams params = new RequestParams();
params.put("name", name);
params.put("email", email);
}
// Added method
static void outputShows(AsyncHttpResponseHandler responseHandler) {
client.get(url + "/shows", responseHandler);
}
static void getShows(AsyncHttpResponseHandler responseHandler) {
client.get(url + "/shows", responseHandler);
}
}
private class JSONAPI{
private void recover(String name){
RequestParams params = new RequestParams();
params.put("name", name);
params.put("email", email);
}
}
"""
""" Second commit """
# Modified API.java
file_path = os.path.join(self.temp_dir, "API.java")
f = open(file_path, "w")
f.write(code_b)
f.close()
self.repo.git.add(file_path)
self.repo.git.commit(m='Second commit')
code = """/* CallingMethodsInSameClass.java
*
* illustrates how to call static methods a class
* from a method in the same class
*/
public class CallingMethodsInSameClass
{
public static void main(String[] args) {
printOne();
printOne();
printTwo();
}
public static void printOne() {
System.out.println("Hello World");
}
public static void printTwo() {
printOne();
printOne();
}
}"""
""" Third commit """
# Added CallingMethodsInSameClass.java
file_path = os.path.join(self.temp_dir,
"CallingMethodsInSameClass.java")
f = open(file_path, "w")
f.write(code)
f.close()
self.repo.git.add(file_path)
# Modified README.txt
file_path = os.path.join(self.temp_dir, "README.txt")
f = open(file_path, "w")
f.write("AUTHORS: Peter Griffin - [email protected]")
f.close()
self.repo.git.add(file_path)
self.repo.git.commit(m='Third commit')
""" Fourth Commit """
# Deleted CallingMethodsInSameClass.java
file_path = os.path.join(self.temp_dir,
"CallingMethodsInSameClass.java")
self.repo.git.rm(file_path)
# Renamed API.java to API2.java
file_path_a = os.path.join(self.temp_dir, "API.java")
file_path_b = os.path.join(self.temp_dir, "API2.java")
self.repo.git.mv(file_path_a, file_path_b)
self.repo.git.commit(m='Fourth commit')
""" Fifth Commit"""
# Modified README.txt
file_path = os.path.join(self.temp_dir, "README.txt")
f = open(file_path, "w")
f.write("AUTHORS: Peter Griffin and Louis Griffin")
f.close()
self.repo.git.add(file_path)
self.repo.git.commit(m='Fifth commit')
""" Sixth Commit"""
# Added ShadowTest.java
code = """public class ShadowTest {
public int x = 0;
class FirstLevel {
public int x = 1;
void methodInFirstLevel(int x) {
System.out.println("x = " + x);
System.out.println("this.x = " + this.x);
System.out.println("ShadowTest.this.x = " + ShadowTest.this.x);
}
}
public static void main(String... args) {
ShadowTest st = new ShadowTest();
ShadowTest.FirstLevel fl = st.new FirstLevel();
fl.methodInFirstLevel(23);
}
}"""
file_path = os.path.join(self.temp_dir, "ShadowTest.java")
f = open(file_path, "w")
f.write(code)
f.close()
self.repo.git.add(file_path)
self.repo.git.commit(m='Sixth commit')
""" Extract """
extractor = GitExtractor(self.temp_dir)
repository = extractor.extract(method_granularity=True, parallel=False)
""" Tests """
self.assertEqual(len(repository.commits),
5,
msg="It should only extract commits related to code")
self.assertTrue(repository.begin_ts < creation_timestamp,
msg="It should extract the timestamp of first commit")
# First commit
self.assertEqual(repository.commits[0].message, "First commit\n")
self.assertEqual(repository.commits[0].author,
"*****@*****.**")
diffs = repository.commits[0].diffs
self.assertEqual(len(diffs), 10)
self.assertTrue(DiffFile(file_b="API.java", added=True) in diffs)
self.assertTrue(
DiffClass(file_name="API.java", class_b="SOAPAPI", added=True) in
diffs)
self.assertTrue(
DiffClass(file_name="API.java", class_b="API", added=True) in
diffs)
self.assertTrue(
DiffMethod(file_name="API.java",
class_name="API",
method_b="getUrl",
added=True) in diffs)
self.assertTrue(
DiffMethod(file_name="API.java",
class_name="API",
method_b="setUrl",
added=True) in diffs)
self.assertTrue(
DiffMethod(file_name="API.java",
class_name="API",
method_b="API",
added=True) in diffs)
self.assertTrue(
DiffMethod(file_name="API.java",
class_name="API",
method_b="login",
added=True) in diffs)
self.assertTrue(
DiffMethod(file_name="API.java",
class_name="API",
method_b="register",
added=True) in diffs)
self.assertTrue(
DiffMethod(file_name="API.java",
class_name="API",
method_b="getShows",
added=True) in diffs)
self.assertTrue(
DiffMethod(file_name="API.java",
class_name="SOAPAPI",
method_b="login",
added=True) in diffs)
# Second commit
self.assertEqual(repository.commits[1].message, "Second commit\n")
diffs = repository.commits[1].diffs
self.assertEqual(len(diffs), 10)
self.assertTrue(
DiffFile(file_a="API.java", file_b="API.java", modified=True) in
diffs)
self.assertTrue(DiffClass("API.java",
class_a="API",
class_b="API",
modified=True) in diffs,
msg="It should recognize modified classes")
self.assertTrue(DiffMethod("API.java",
class_name="API",
method_a="login",
method_b="login",
modified=True) in diffs,
msg="It should recognize modified methods")
self.assertTrue(DiffMethod("API.java",
class_name="API",
method_a="register",
removed=True) in diffs,
msg="It should recognize removed methods")
self.assertTrue(DiffMethod("API.java",
class_name="API",
method_b="recover",
added=True) in diffs,
msg="It should recognize added methods")
self.assertTrue(DiffMethod("API.java",
class_name="API",
method_b="outputShows",
added=True) in diffs,
msg="It should recognize added methods")
self.assertTrue(DiffClass("API.java", class_a="SOAPAPI", removed=True)
in diffs,
msg="It should recognize removed classes")
self.assertTrue(DiffClass("API.java", class_b="JSONAPI", added=True)
in diffs,
msg="It should recognize added classes")
self.assertTrue(DiffMethod("API.java",
class_name="SOAPAPI",
method_a="login",
removed=True) in diffs,
msg="It should recognize removed methods")
self.assertTrue(DiffMethod("API.java",
class_name="JSONAPI",
method_b="recover",
added=True) in diffs,
msg="It should recognize added methods")
# Third commit
self.assertEqual(repository.commits[2].message, "Third commit\n")
diffs = repository.commits[2].diffs
self.assertEqual(len(diffs), 5)
self.assertTrue(
DiffFile(file_b="CallingMethodsInSameClass.java", added=True) in
diffs)
self.assertTrue(
DiffClass(file_name="CallingMethodsInSameClass.java",
class_b="CallingMethodsInSameClass",
added=True) in diffs)
self.assertTrue(
DiffMethod(file_name="CallingMethodsInSameClass.java",
class_name="CallingMethodsInSameClass",
method_b="main",
added=True) in diffs)
self.assertTrue(
DiffMethod(file_name="CallingMethodsInSameClass.java",
class_name="CallingMethodsInSameClass",
method_b="printOne",
added=True) in diffs)
self.assertTrue(
DiffMethod(file_name="CallingMethodsInSameClass.java",
class_name="CallingMethodsInSameClass",
method_b="printTwo",
added=True) in diffs)
# Fourth commit
self.assertEqual(repository.commits[3].message, "Fourth commit\n")
diffs = repository.commits[3].diffs
self.assertEqual(len(diffs), 2)
self.assertTrue(
DiffFile(file_a="API.java", file_b="API2.java", renamed=True) in
diffs)
self.assertTrue(
DiffFile(file_a="CallingMethodsInSameClass.java", removed=True) in
diffs)
# Sixth commit
self.assertEqual(repository.commits[4].message, "Sixth commit\n")
diffs = repository.commits[4].diffs
self.assertEqual(len(diffs), 5)
self.assertTrue(
DiffFile(file_b="ShadowTest.java", added=True) in diffs)
self.assertTrue(DiffClass(file_name="ShadowTest.java",
class_b="ShadowTest.FirstLevel",
added=True) in diffs,
msg="It should recognize nested classes")
self.assertTrue(
DiffClass(file_name="ShadowTest.java",
class_b="ShadowTest",
added=True) in diffs)
self.assertTrue(DiffMethod(file_name="ShadowTest.java",
class_name="ShadowTest.FirstLevel",
method_b="methodInFirstLevel",
added=True) in diffs,
msg="It should recognize nested classes")
self.assertTrue(
DiffMethod(file_name="ShadowTest.java",
class_name="ShadowTest",
method_b="main",
added=True) in diffs)
