-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #12 from Colin-b/develop
Release 0.4.0
- Loading branch information
Showing
6 changed files
with
223 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| from typing import Union | ||
|
|
||
| import flask_restx | ||
| import flask | ||
|
|
||
| from keepachangelog._changelog import to_dict | ||
|
|
||
|
|
||
| def add_changelog_endpoint( | ||
| namespace: Union[flask_restx.Namespace, flask_restx.Api], changelog_path: str | ||
| ): | ||
| """ | ||
| Create /changelog: Changelog endpoint parsing https://keepachangelog.com/en/1.0.0/ | ||
| :param namespace: The Flask-RestX namespace. | ||
| :param changelog_path: Path to CHANGELOG.md. | ||
| """ | ||
|
|
||
| @namespace.route("/changelog") | ||
| @namespace.doc( | ||
| responses={ | ||
| 200: ( | ||
| "Service changelog.", | ||
| [ | ||
| namespace.model( | ||
| "ChangelogReleaseModel", | ||
| { | ||
| "version": flask_restx.fields.String( | ||
| description="Release version following semantic versioning.", | ||
| required=True, | ||
| example="3.12.5", | ||
| ), | ||
| "release_date": flask_restx.fields.Date( | ||
| description="Release date.", | ||
| required=True, | ||
| example="2019-12-31", | ||
| ), | ||
| "added": flask_restx.fields.List( | ||
| flask_restx.fields.String(description="New features.") | ||
| ), | ||
| "changed": flask_restx.fields.List( | ||
| flask_restx.fields.String( | ||
| description="Changes in existing functionaliy." | ||
| ) | ||
| ), | ||
| "deprecated": flask_restx.fields.List( | ||
| flask_restx.fields.String( | ||
| description="Soon-to-be removed features." | ||
| ) | ||
| ), | ||
| "removed": flask_restx.fields.List( | ||
| flask_restx.fields.String( | ||
| description="Removed features." | ||
| ) | ||
| ), | ||
| "fixed": flask_restx.fields.List( | ||
| flask_restx.fields.String(description="Any bug fixes.") | ||
| ), | ||
| "security": flask_restx.fields.List( | ||
| flask_restx.fields.String( | ||
| description="Vulnerabilities." | ||
| ) | ||
| ), | ||
| }, | ||
| ) | ||
| ], | ||
| ) | ||
| } | ||
| ) | ||
| class Changelog(flask_restx.Resource): | ||
| def get(self): | ||
| """ | ||
| Retrieve service changelog. | ||
| """ | ||
| try: | ||
| return flask.jsonify(to_dict(changelog_path)) | ||
| except FileNotFoundError: | ||
| return flask.jsonify({}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| import os | ||
|
|
||
| import flask | ||
| import flask_restx | ||
|
|
||
| from keepachangelog.flask_restx import add_changelog_endpoint | ||
|
|
||
|
|
||
| def test_changelog_endpoint_with_file(tmpdir): | ||
| changelog_file_path = os.path.join(tmpdir, "CHANGELOG.md") | ||
| with open(changelog_file_path, "wt") as file: | ||
| file.write( | ||
| """# Changelog | ||
| All notable changes to this project will be documented in this file. | ||
| The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | ||
| and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
| ## [Unreleased] | ||
| ### Changed | ||
| - Release note 1. | ||
| - Release note 2. | ||
| ### Added | ||
| - Enhancement 1 | ||
| - sub enhancement 1 | ||
| - sub enhancement 2 | ||
| - Enhancement 2 | ||
| ### Fixed | ||
| - Bug fix 1 | ||
| - sub bug 1 | ||
| - sub bug 2 | ||
| - Bug fix 2 | ||
| ### Security | ||
| - Known issue 1 | ||
| - Known issue 2 | ||
| ### Deprecated | ||
| - Deprecated feature 1 | ||
| - Future removal 2 | ||
| ### Removed | ||
| - Deprecated feature 2 | ||
| - Future removal 1 | ||
| ## [1.1.0] - 2018-05-31 | ||
| ### Changed | ||
| - Enhancement 1 (1.1.0) | ||
| - sub enhancement 1 | ||
| - sub enhancement 2 | ||
| - Enhancement 2 (1.1.0) | ||
| ## [1.0.1] - 2018-05-31 | ||
| ### Fixed | ||
| - Bug fix 1 (1.0.1) | ||
| - sub bug 1 | ||
| - sub bug 2 | ||
| - Bug fix 2 (1.0.1) | ||
| ## [1.0.0] - 2017-04-10 | ||
| ### Deprecated | ||
| - Known issue 1 (1.0.0) | ||
| - Known issue 2 (1.0.0) | ||
| [Unreleased]: https://github.test_url/test_project/compare/v1.1.0...HEAD | ||
| [1.1.0]: https://github.test_url/test_project/compare/v1.0.1...v1.1.0 | ||
| [1.0.1]: https://github.test_url/test_project/compare/v1.0.0...v1.0.1 | ||
| [1.0.0]: https://github.test_url/test_project/releases/tag/v1.0.0 | ||
| """ | ||
| ) | ||
|
|
||
| app = flask.Flask(__name__) | ||
| api = flask_restx.Api(app) | ||
| add_changelog_endpoint(api, changelog_file_path) | ||
| with app.test_client() as client: | ||
| response = client.get("/changelog") | ||
| assert response.status_code == 200 | ||
| assert response.json == { | ||
| "1.1.0": { | ||
| "changed": [ | ||
| "Enhancement 1 (1.1.0)", | ||
| "sub enhancement 1", | ||
| "sub enhancement 2", | ||
| "Enhancement 2 (1.1.0)", | ||
| ], | ||
| "release_date": "2018-05-31", | ||
| "version": "1.1.0", | ||
| }, | ||
| "1.0.1": { | ||
| "fixed": [ | ||
| "Bug fix 1 (1.0.1)", | ||
| "sub bug 1", | ||
| "sub bug 2", | ||
| "Bug fix 2 (1.0.1)", | ||
| ], | ||
| "release_date": "2018-05-31", | ||
| "version": "1.0.1", | ||
| }, | ||
| "1.0.0": { | ||
| "deprecated": ["Known issue 1 (1.0.0)", "Known issue 2 (1.0.0)"], | ||
| "release_date": "2017-04-10", | ||
| "version": "1.0.0", | ||
| }, | ||
| } | ||
|
|
||
|
|
||
| def test_changelog_endpoint_without_file(): | ||
| app = flask.Flask(__name__) | ||
| api = flask_restx.Api(app) | ||
| add_changelog_endpoint(api, "non existing") | ||
| with app.test_client() as client: | ||
| response = client.get("/changelog") | ||
| assert response.status_code == 200 | ||
| assert response.json == {} |