Skip to content

[RIT] Data Piping - Create TSDetect API #146

@bdr1224

Description

@bdr1224

Story

As a TSDetect plugin user I want the data collected from the plugin to be sent to the remote database so that it can be stored for future reference.

Requirements

  • Data sent to the API should be received in the form of a Json-wrapped Hashmap with the following pattern of String key: String value pairs
    • userID : String (userID)
    • Timestamp : String (yyyy-mm-dd hh:mm:ss)
    • Testsmell Name : String (Number of that test smell found)
      • Step c is repeated the required number of times to incorporate all test smells
  • The input API will have a single endpoint, reached with the following call:
    • POST /test-results
      • This endpoint Header information:
        • content-type: application/json
          • This content includes the data mentioned in requirement III.A.1
  • This POST message will return a 200 code on a successful connection.
    • Any other code should be considered a failure
  • Once received, the Hashmap listed in requirement III.A.1 shall be unwrapped and transformed into a csv of the following format:
    • Uid, timestamp, (testsmell1, testsmell2, …)
  • The CSV generated shall be stored locally until it is collected by the repository layer classes
  • Once the CSV has been created, the api shall notify the repository layer classes that there is a new csv to process.
    • This notification shall include the name and location of the csv.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions