Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RIT] Data Piping - Create TSDetect API #146

Open
bdr1224 opened this issue Nov 1, 2022 · 0 comments
Open

[RIT] Data Piping - Create TSDetect API #146

bdr1224 opened this issue Nov 1, 2022 · 0 comments
Assignees

Comments

@bdr1224
Copy link
Contributor

bdr1224 commented Nov 1, 2022

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.
@bdr1224 bdr1224 self-assigned this Nov 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant