fix: Flask service and api_invocation() are up-to-date with DFD_extraction()

It is possible to provide a commit hash also to Flask request

Author: bakhtos

README.md

@@ -38,7 +38,8 @@ If you want to analyse in application on GitHub, simply put in the GitHub handle
 For example, for the repository `https://github.com/sqshq/piggymetrics`, run the command `python3 code2DFD.py --github_path sqshq/piggymetrics`
 
 To run the tool as a RESTful API service, run `python3 flask_code2DFD.py`.
-This will spawn up a Flask server and you can trigger DFD-extractions by sending a request to or opening your browser at `localhost:5000/dfd?path=*repository/path*`
+This will spawn up a Flask server and you can trigger DFD-extractions by sending a request to `localhost:5001/dfd` with parameters `url` and optionally `commit`.
+Currently only GitHub URLs are supported this way.
 
 
 ##### 3. Output

code2DFD.py

@@ -10,7 +10,6 @@
 import core.dfd_extraction as dfd_extraction
 from output_generators.logger import logger
 import tmp.tmp as tmp
-from core.file_interaction import clone_repo
 
 CONFIG_SECTIONS = ["Analysis Settings", "Repository", "Technology Profiles", "DFD"]
 COMMUNICATIONS_TECH_LIST = '[("RabbitMQ", "rmq"), ("Kafka", "kfk"), ("RestTemplate", "rst"),\
@@ -24,33 +23,35 @@
 DEFAULT_CONFIG.set("Technology Profiles", "communication_techs_list", COMMUNICATIONS_TECH_LIST)
 
 
-def api_invocation(path: str) -> dict:
+def api_invocation(url: str, commit: str) -> dict:
  """Entry function for when tool is called via API call.
  """
 
- print("New call for " + path)
- response = dict()
+ repo_path = url.split("github.com/")[1] # TODO This needs to generalize beyond GitHub
+ print("New call for " + repo_path)
 
  start_time = datetime.now()
 
  logger.info("*** New execution ***")
- logger.debug("Copying config file to tmp file")
+ logger.debug("Initializing config to tmp file")
+ for section in CONFIG_SECTIONS: # Copying what is needed from default to temp
+ tmp.tmp_config.add_section(section)
+ for entry in DEFAULT_CONFIG[section]:
+ tmp.tmp_config.set(section, entry, DEFAULT_CONFIG[section][entry])
 
  # Overwrite repo_path from config file with the one from the API call
- # TODO add analysis of specific commit with Flask API
- repo_path = str(path)
  tmp.tmp_config.set("Repository", "path", repo_path)
-
- local_path = os.path.join(os.getcwd(), "analysed_repositories", *repo_path.split("/")[1:])
- tmp.tmp_config.set("Repository", "local_path", local_path)
-
- clone_repo(repo_path, local_path) # TODO use Pydriller
+ tmp.tmp_config.set("Repository", "local_path",
+ os.path.join(os.getcwd(), "analysed_repositories"))
+ if commit is not None:
+ tmp.tmp_config.set("Analysis Settings", "commit", commit)
 
  # Call extraction
  codeable_models, traceability = dfd_extraction.perform_analysis()
 
+ response = dict()
  response["codeable_models_file"] = codeable_models
- response["traceability"] = traceability
+ response["traceability_file"] = traceability
 
  # Execution time
  end_time = datetime.now()

flask_code2DFD.py

@@ -4,42 +4,33 @@
 
 app = Flask(__name__, instance_relative_config = True)
 
-# Create default endpoint
+
 @app.get('/')
 def index():
- index_message = "API for DFD extraction. \
+ index_message = ("API for DFD extraction. \
  Provide a GitHub URL to endpoint /dfd as parameter \"url\" to receive the extracted DFD: \
  /dfd?url=https://github.com/georgwittberger/apache-spring-boot \
- -microservice-example"
+ -microservice-example; \
+ Optionally provide a commit hash as \"commit\" parameter")
 
  return index_message
 
 
-# Create endpoint /dfd
 @app.get('/dfd')
 def dfd():
 
- # Retrieve argument 'path' from request
  url = request.args.get("url")
+ commit = request.args.get("commit", None)
 
  if not url:
  return "Please specify a URL, e.g. /dfd?url=https://github.com/georgwittberger/apache-spring-boot" \
  "-microservice-example "
- try:
- path = url.split("github.com/")[1]
- except:
- return "Please specify the complete URL, e.g. /dfd?url=https://github.com/georgwittberger/apache-spring-boot" \
- "-microservice-example "
 
  # Call Code2DFD
- results = code2DFD.api_invocation(path)
+ results = code2DFD.api_invocation(url, commit)
 
  # Create response JSON object and return it
- response = jsonify(
- codeable_models_file = results["codeable_models_file"],
- traceability_file = results["traceability"],
- execution_time = results["execution_time"]
- )
+ response = jsonify(**results)
 
  return response