WARNING! Gitlab maintenance operation scheduled for Monday, 20 April between 12:00 and 14:00 (CET). During this time window, short service interruptions (less than 5 minutes) may occur. Thank you in advance for your understanding.
The `doc2oas_automation_script.py` is a Python script designed to automate the process of OpenAPI Specification (OAS) generation from the MEC Specs. What the script does is: it downloads the latest MEC Specs from the ETSI Portal, generates OAS, and pushes the generated OAS to the doc2oas repository under the `auto_generated_oas` branch. The script utilizes Selenium, a very famous web automation tool, to interact with the ETSI portal and then handle the necessary operations.
## Key Features
## Getting started
-**Automated Document Extraction:** The script navigates through the ETSI portal, searches for the available latest MEC Specs, and if they're there, it downloads the most recent versions of the documents.
-**Version Management:** The script manages the document versions, stores the latest downloaded versions, updates the script's configuration, and next time it checks the next available versions.
-**Conversion to OAS Format:** The `doc2oas_automation_script.py` script uses the `doc2oas.sh` script and generates the OAS from the downloaded MEC Specs, ensuring that the specifications are ready for integration with API tools and platforms.
-**ETSI Forge Integration:** After successful generation of the OAS, the script automatically adds, commits, and pushes the changes to `auto_generated_oas` branch in a ETSI Forge doc2oas repository, keeping the repository up-to-date with the latest document versions.
-**OAS Versions:** The script keeps all the generated OAS files, so developers can use the required OAS file(s).
-**Cron Job Support:** The script can be scheduled to run at specific intervals using a cron job, allowing for regular and automated updates.
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
## Prerequisites
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
Before using the `doc2oas_automation_script.py` script, make sure you have all the following prerequisites:
## Add your files
1.**Install Google Chrome and ChromeDriver:** It is essential to use Google Chrome browser and ChromeDriver of the same versions. To install Google Chrome and ChromeDriver, follow these steps:
-[ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-[ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
- Install Google Chrome by following the instructions provided in this [Google Chrome Installation Guide](https://operavps.com/docs/install-google-chrome-on-ubuntu/).
- Download the ChromeDriver zip file from the [ChromeDriver Download Page](https://googlechromelabs.github.io/chrome-for-testing/) and follow the steps below to install it:
-[ ] [Set up project integrations](https://forge.etsi.org/rep/mec/auto-generated-oas/-/settings/integrations)
## Collaborate with your team
-[ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-[ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-[ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-[ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
### Installing ChromeDriver on Ubuntu
Use the built-in continuous integration in GitLab.
As mentioned in the previous step, after downloading the ChromeDriver zip file, follow these steps to install it on Ubuntu:
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-[ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-[ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-[ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-[ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
1.**Unzip the ChromeDriver Zip File:** Extract the contents of the downloaded ChromeDriver zip file using the following command:
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
```bash
unzip chromedriver_linux64.zip
```
## Name
Choose a self-explaining name for your project.
2.**Move ChromeDriver to a System Directory:** Move the extracted ChromeDriver binary to a directory that is included in the system's PATH. The `/usr/local/bin` directory is a common choice for this purpose. Use the following command:
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
```bash
sudo mv chromedriver /usr/local/bin/
```
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
3.**Set Permissions:** Make sure that the ChromeDriver binary has the necessary permissions to be executed. Use the following command:
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
```bash
sudo chmod +x /usr/local/bin/chromedriver
```
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
4.**Verify Installation:** Check if ChromeDriver is successfully installed by running the following command:
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
```bash
chromedriver --version
```
This should display the version of ChromeDriver installed.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
### Python Environment
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
Ensure you have Python 3.x installed on your system
- Credentials for the ETSI portal and ETSI Forge repository configured within the script.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
## Getting Started
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
1. Clone this repository to your local machine.
2. Open the cloned folder, check out to the `auto_generated_oas` branch, and Install the required Python packages by running `pip install -r requirement.txt`.
3. It is essential have **same versions** of Chrome browser and ChromeDriver. This compatibility between the browser and driver versions is crucial for seamless and reliable web automation using the `doc2oas_automation_script.py` script.
4. Modify the script variables such as `username`, `password`, `document_list`, and others according to your requirements.
5. Run the script manually to test the automation process: `python3 doc2oas_automation_script.py`.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## Note About Generated OpenAPIs
## License
For open source projects, say how it is licensed.
Note that while the `doc2oas_automation_script.py` tool aims to provide OpenAPI specifications, the generated OpenAPIs may not always be 100% correct. The reason for this is that the configuration files, which are used to generate the specifications, need to be updated manually. In many cases, the configuration file remains the same for the latest version, but there are instances where modifications in the configuration files are required for the latest versions.
## Suggestions
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
Suggestions to further improve the automation of OAS generation are highly encouraged. If you identify areas for improvement or encounter issues feel free to raise issues.
