An open API service indexing awesome lists of open source software.

https://github.com/nityagautam/testcenter4jenkins

Test Dashboard application for Jenkins job and offline reports
https://github.com/nityagautam/testcenter4jenkins

bootstrap5 dashboard-application flask-application javascript jinja2 jinja2-templates python python3 report-crawler

Last synced: about 1 month ago
JSON representation

Test Dashboard application for Jenkins job and offline reports

Awesome Lists containing this project

README

          

### (TestCenter4Jenkins) A TestCenter/Dashboard for the jenkins job


###### Description
It is the combination of few services which gets/crawls the reports and manage the report on the disk as well as in to the database; it keeps cleaning the old records and keeps last 20-30(as configured) records.


# Application Structure
# ==========================
# ReportDashboard
# \____ app # This is the application source dir
# |____ client
# |____ static # This contains all the static sources like: js, css, images, etc
# |____ templates # This contains all the HTML source files
#
# |____ server
# |____ entire source code lies here # This has all the python3 back-end server logic
# |____ config
# |________ # This contains all configurations (app, db, etc)
# |____ crawlers
# |____ dbase
# |____ routes
# |____ unittests
# |____ utilities
# |____ views
#
# |____ __init__.py
# |____ settings.py
#
# |____ LICENSE
# |____ main.py # This is the entry point; starts the server
# |____ pytest.ini # This is pytest configuration for testing server
# |____ README.md # Refer this file for more details of HowTo
# |____ requirements.txt # Python packages requirement file
#

###### There are three section of this application
1. Crawler + Sqlite3
2. FrontEnd (Bootstrap v5)
3. Server (Flask)

###### TODO LIST
- Edit Project
- Logging

###### Screenshots
Will go here ...

###### Setup
Just clone the repo/code and install the requirements;
> `python3 -m pip install requirements.txt`

###### Application Usage
> Usage
>
> `python3 main.py`

> Usage to start a crawling:
>
> `python3 main.py --debug-mode --crawl=crawl_directory`

> Server Usage:
>
> `python3 main.py --debug-mode --start-server --port=port_no`

> Separate Usage:
>
> `python3 crawler.py --crawl=crawl_directory --verbose`
>
> `python3 server.py --port=port_no --verbose`


###### Bootstrap Resources
- Icons: https://icons.getbootstrap.com/
- Elements:
- etc:

###### Template Rendering args
1st arg: template file

2nd arg: username in session

3rd arg: ui_config

4th arg: data (related to projects and all)


 

Syntax:
render_template("index.html",
page_name="",
username=session['user'],
ui_configuration=app_ui_config,
data=sample_data.latest_data)
Example:
render_template(ui_config["/index"]["template_name"],
page_name = ui_config["/index"]["page_name"],
username = ,
ui_configuration = ,
data
)



Developer: nityanarayan44@live.com