This repository contains the backend server for the Task Scheduling front-end. The backend is responsible for processing the logical model, running scheduling algorithms, and communicating with the frontend. It is built with FastAPI and provides a RESTful API for interaction with the frontend.
- Clone the repository:
git clone https://github.com/linem-davton/es-lab-task2.git-
Navigate to the project directory:
cd es-lab-task2 -
Install dependencies:
pip install -r requirements.txt
-
Start the development server:
python3 src/backend.py
The backend server will start running on http://localhost:8000
-
Access the API: The backend server will be running at http://localhost:8000. If everything is set up correctly, you should see the following message: {"Hello": "World"}
-
To access the API documentation, go to http://localhost:8000/docs.
-
Visit the frontend at eslab2.pages.dev, and input the logical and platform model as defined in input schema to schedule tasks.
- RESTful API: Provides endpoints for scheduling tasks and retrieving schedules.
- Multiple Scheduling Algorithms: Implements LDF and EDF scheduling algorithms for task scheduling.
- Input Validation: Ensures valid data format for processing.
- Cross-Origin Resource Sharing (CORS): Enabled for specified origins.
- POST /schedule_jobs: Accepts a task graph in JSON format and returns the scheduled tasks using four different algorithms.
- GET /get_jobs: Endpoint for retrieving task schedules.
- GET /: Root endpoint to verify if the server is running.
Learn more about HTTP Methods
The backend expects input in the following JSON schema:
This JSON Schema defines the structure for the input JSON model used by the scheduling algorithms. It ensures the correct format and validation of the input data.
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"application": {
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"wcet": {
"type": "integer"
},
"mcet": {
"type": "integer"
},
"deadline": {
"type": "integer"
}
},
"required": [
"id",
"wcet",
"mcet",
"deadline"
]
}
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"sender": {
"type": "integer"
},
"receiver": {
"type": "integer"
},
"size": {
"type": "integer"
}
},
"required": [
"id",
"sender",
"receiver",
"size"
]
}
}
},
"required": [
"tasks",
"messages"
]
},
"platform": {
"type": "object",
"properties": {
"nodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"start_node": {
"type": [
"string",
"integer"
]
},
"end_node": {
"type": [
"string",
"integer"
]
},
"link_delay": {
"type": "integer"
},
"bandwidth": {
"type": "integer"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"start_node",
"end_node",
"link_delay",
"bandwidth",
"type"
]
}
}
},
"required": [
"nodes",
"links"
]
}
},
"required": [
"application",
"platform"
]
}This schema defines the structure for the application and platform objects required by the scheduling algorithms. It ensures that:
- Tasks: Each task has an id, wcet (worst case execution time), mcet (mean case execution time), and deadline (all integers).
- Messages: Each message has an id, sender, receiver, size (all integers), and timetriggered (integer).
- Nodes: Each node has an id (integer) and type (string).
- Links: Each link has an id, start_node, end_node, link_delay, bandwidth (all integers), and type (string). By adhering to this schema, you can validate the input JSON model before processing it with the scheduling algorithms.
This JSON Schema defines the structure for the output schedule generated by the scheduling algorithms. It ensures the correct format and validation of the output data.
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"schedule": {
"type": "array",
"items": {
"type": "object",
"properties": {
"task_id": {
"type": "integer"
},
"node_id": {
"type": "integer"
},
"start_time": {
"type": "integer"
},
"end_time": {
"type": "integer"
},
"deadline": {
"type": "integer"
}
},
"required": [
"task_id",
"node_id",
"start_time",
"end_time",
"deadline"
]
}
},
"name": {
"type": "string"
},
"missed_deadlines": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"required": [
"schedule",
"name"
]
}
This schema defines the structure for the schedule object produced by the scheduling algorithms. It ensures that each scheduled item has:
- task_id: The identifier of the task, which can be a string or integer.
- node_id: The identifier of the node where the task is scheduled, which can be a string or integer.
- start_time: The time when the task starts execution.
- end_time: The time when the task finishes execution.
- deadline: The deadline by which the task must be completed.
- backend.py: Main entry point for the FastAPI backend server.
- Handles API endpoints and routing.
- Configures CORS middleware.
- algorithms.py: Contains the implementation of the scheduling algorithms (LDF, EDF, LL).
- config.json: Configuration file for backend settings.
- requirements.txt: File listing all the dependencies required for the project.
Contributions are welcome! Please follow these steps to contribute:
- Fork the repository.
- Create a new branch (git checkout -b feature/your-feature-name).
- Make your changes.
- Commit your changes (git commit -m 'Add some feature').
- Push to the branch (git push origin feature/your-feature-name).
- Create a new Pull Request.
- Github Backend Repository: Task Scheduling Backend
- Github Frontend Repository: Task Scheduling Frontend