Compare commits
23 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 2bdc7a19ab | |||
|
f1f7046c49 | ||
|
|
0cd8b1404a | ||
|
|
3391c7282c | ||
|
|
225a700d10 | ||
|
|
778938a28a | ||
|
|
48eacc4d69 | ||
|
|
807e564380 | ||
|
|
236efcc258 | ||
|
|
e4df9f7d77 | ||
|
|
418eec803d | ||
|
|
8a01ad04bb | ||
|
|
1be6751d5c | ||
|
|
407282f70e | ||
|
|
198337e877 | ||
|
|
d1a34fafe3 | ||
|
|
010145a0a8 | ||
|
|
1ed87d05f6 | ||
|
|
2d8d2f2a74 | ||
|
|
8d68edd4ab | ||
|
|
f0bdbfcdbf | ||
|
|
408a811b82 | ||
|
|
28fff91cbe |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -41,3 +41,5 @@ docs
|
||||
helpers-results
|
||||
.coverage
|
||||
/.mypy_cache/
|
||||
.coverage
|
||||
.mypy_cache
|
||||
136
Jenkinsfile
vendored
136
Jenkinsfile
vendored
@@ -26,7 +26,7 @@ def _bPreRelease = false
|
||||
def _bDraft = false
|
||||
// release content / changelog management
|
||||
def _bAutoChangelog = true //Not supported yet
|
||||
def _ReleaseContent_Title = "_CI/CD Automatic Release_"
|
||||
def _ReleaseContent_Title = "# _CI/CD Automatic Release_"
|
||||
def bPushMasterOnPypi = true
|
||||
// full rebuild toogle
|
||||
def _bFullRebuilt = true
|
||||
@@ -148,6 +148,7 @@ pipeline {
|
||||
PY_PROJECT_NAME = "__NOTSET__"
|
||||
PY_PROJECT_VERSION = "__NOTSET__"
|
||||
PY_PROJECT_VERSION_STRIPPED = "__NOTSET__"
|
||||
CHANGELOG = "__NOTSET__"
|
||||
}
|
||||
|
||||
stages {
|
||||
@@ -182,18 +183,20 @@ pipeline {
|
||||
sh("virtualenv --pip=embed --setuptools=embed --wheel=embed --no-periodic-update --activators bash,python TEST_ENV")
|
||||
sh("virtualenv --pip=embed --setuptools=embed --wheel=embed --no-periodic-update --activators bash,python TOOLS_ENV")
|
||||
|
||||
sh(". ~/BUILD_ENV/bin/activate && pip install --upgrade setuptools build pip copier jinja2-slug toml")
|
||||
sh(". ~/BUILD_ENV/bin/activate && pip install --upgrade setuptools build pip")
|
||||
sh(". ~/BUILD_ENV/bin/activate && pip install --upgrade 'copier==9.*' jinja2-slug toml")
|
||||
|
||||
sh(". ~/TEST_ENV/bin/activate && pip install --upgrade pip")
|
||||
|
||||
sh(". ~/TOOLS_ENV/bin/activate && pip install simple_rest_client requests twine")
|
||||
sh(". ~/TOOLS_ENV/bin/activate && pip install --upgrade pip")
|
||||
sh(". ~/TOOLS_ENV/bin/activate && pip install simple_rest_client requests twine packaging")
|
||||
|
||||
script {
|
||||
if(_PROJECT_NAME!="pygitversionhelper") {
|
||||
sh(". ~/TOOLS_ENV/bin/activate && pip install pygitversionhelper")
|
||||
}
|
||||
else
|
||||
{
|
||||
//TODO: need to install pygitversionhelper deps from a better way...
|
||||
sh(". ~/TOOLS_ENV/bin/activate && pip install packaging")
|
||||
if(_PROJECT_NAME!="pychangelogfactory") {
|
||||
sh(". ~/TOOLS_ENV/bin/activate && pip install pychangelogfactory")
|
||||
}
|
||||
}
|
||||
sh("git config --global user.email $_MaintainerEmail")
|
||||
@@ -217,6 +220,32 @@ pipeline {
|
||||
withCredentials([usernamePassword(credentialsId: _SCMCredentials, passwordVariable: 'GIT_PASSWORD', usernameVariable: 'GIT_USERNAME')]) {
|
||||
sh("git remote set-url origin https://${GIT_USERNAME}:${GIT_PASSWORD}@chacha.ddns.net/gitea/${_PROJECT_USER_NAME}/${_PROJECT_NAME}.git")
|
||||
}
|
||||
|
||||
CHANGELOG = sh(script: """#!/bin/sh -
|
||||
|. ~/TOOLS_ENV/bin/activate
|
||||
|exec python - << '__EOWRAPPER__'
|
||||
|
|
||||
|import re
|
||||
|
|
||||
|try:
|
||||
| from pychangelogfactory import ChangelogFactory
|
||||
|except ImportError:
|
||||
| from src.pychangelogfactory import ChangelogFactory
|
||||
|
|
||||
|try:
|
||||
| from pygitversionhelper import gitversionhelper
|
||||
|except ImportError:
|
||||
| from src.pygitversionhelper import gitversionhelper
|
||||
|
|
||||
|
|
||||
|LastTag=gitversionhelper.tag.getLastTag(same_branch=True)
|
||||
|CommitHistory=gitversionhelper.commit.getMessagesSinceTag(LastTag, merged_output=True, ignore_merged=True)
|
||||
|Changelog = ChangelogFactory(CommitHistory).RenderFullChangelog(include_unknown=True)
|
||||
|print(Changelog.replace("\\n","\\n\\n"))
|
||||
|
|
||||
|__EOWRAPPER__
|
||||
""".stripMargin(),
|
||||
returnStdout: true).trim()
|
||||
|
||||
if(_GIT_BRANCH=="master") {
|
||||
if(sh(returnStdout: true, script: "git tag --points-at HEAD").trim().isEmpty()) {
|
||||
@@ -316,7 +345,7 @@ pipeline {
|
||||
|'''.strip()
|
||||
|
|
||||
|import copier
|
||||
|copier.run_auto("./", "../_gitrepo",vcs_ref="HEAD",use_prereleases=True,defaults=True,cleanup_on_error=False)
|
||||
|copier.run_copy("./", "../_gitrepo",vcs_ref="HEAD",use_prereleases=True,defaults=True,cleanup_on_error=False,unsafe=True)
|
||||
|
|
||||
|__EOWRAPPER__
|
||||
""".stripMargin())
|
||||
@@ -384,27 +413,44 @@ pipeline {
|
||||
stage("CheckCode") {
|
||||
steps {
|
||||
dir("gitrepo") {
|
||||
sh(". ~/TEST_ENV/bin/activate && python -m helpers --type-check --quality-check")
|
||||
sh(". ~/TEST_ENV/bin/activate && python -m chacha_cicd_helper --typecheck --qualitycheck")
|
||||
script {
|
||||
def jsonObj = readJSON file: "helpers-results/quality_check/metrics.json"
|
||||
def jsonObj = readJSON file: "helpers-results/cl_quality_check/metrics.json"
|
||||
quality_score = new BigDecimal(jsonObj["GlobalScore"])
|
||||
sz_quality_score = quality_score.setScale(2, RoundingMode.HALF_EVEN).toString()
|
||||
badge_quality.setStatus(sz_quality_score)
|
||||
badge_quality.setColor(getColorScale(quality_score))
|
||||
}
|
||||
sh(". ~/TEST_ENV/bin/activate && python -m helpers --complexity-check")
|
||||
sh(". ~/TEST_ENV/bin/activate && python -m chacha_cicd_helper --complexitycheck")
|
||||
}
|
||||
}
|
||||
post {
|
||||
always {
|
||||
dir("gitrepo") {
|
||||
publishHTML([
|
||||
reportDir: "helpers-results/quality_check",
|
||||
reportFiles: "report.html",
|
||||
reportName: "quality-report",
|
||||
allowMissing: false,
|
||||
alwaysLinkToLastBuild: true,
|
||||
keepAll: true])
|
||||
dir("gitrepo") {
|
||||
//publish coverage
|
||||
recordCoverage( sourceDirectories: [[path: 'src']],
|
||||
tools: [[parser: 'COBERTURA', pattern: 'helpers-results/cl_types_check/cobertura.xml']],
|
||||
id: 'COBERTURA', name: 'COBERTURA Coverage',
|
||||
sourceCodeRetention: 'EVERY_BUILD',)
|
||||
|
||||
//add type check to junit result set
|
||||
junit 'helpers-results/cl_types_check/junit.xml'
|
||||
|
||||
//publish html reports files
|
||||
publishHTML([
|
||||
reportDir: "helpers-results/cl_quality_check",
|
||||
reportFiles: "report.html",
|
||||
reportName: "quality-report",
|
||||
allowMissing: false,
|
||||
alwaysLinkToLastBuild: true,
|
||||
keepAll: true])
|
||||
publishHTML([
|
||||
reportDir: "helpers-results/cl_types_check",
|
||||
reportFiles: "index.html",
|
||||
reportName: "types_check",
|
||||
allowMissing: false,
|
||||
alwaysLinkToLastBuild: true,
|
||||
keepAll: true])
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -413,7 +459,7 @@ pipeline {
|
||||
steps {
|
||||
|
||||
plot([ csvFileName: 'plot-df7f03dc-8146-11ed-a1eb-0242ac120002.csv',
|
||||
csvSeries: [[ file: 'gitrepo/helpers-results/quality_check/metrics_GlobalScore.csv', inclusionFlag: 'OFF', url: '']],
|
||||
csvSeries: [[ file: 'gitrepo/helpers-results/cl_quality_check/metrics_GlobalScore.csv', inclusionFlag: 'OFF', url: '']],
|
||||
group: 'metrics',
|
||||
title: 'code quality score',
|
||||
style: 'line',
|
||||
@@ -423,7 +469,7 @@ pipeline {
|
||||
yaxisMinimum: '0'])
|
||||
|
||||
plot([ csvFileName: 'plot-c731cc84-8145-11ed-a1eb-0242ac120002.csv',
|
||||
csvSeries: [[ file: 'gitrepo/helpers-results/quality_check/metrics_rawpercent.csv', inclusionFlag: 'OFF', url: '']],
|
||||
csvSeries: [[ file: 'gitrepo/helpers-results/cl_quality_check/metrics_rawpercent.csv', inclusionFlag: 'OFF', url: '']],
|
||||
group: 'metrics',
|
||||
title: 'code composition (%)',
|
||||
style: 'stackedArea',
|
||||
@@ -433,7 +479,7 @@ pipeline {
|
||||
yaxisMinimum: '0'])
|
||||
|
||||
plot([ csvFileName: 'plot-cac33982-8145-11ed-a1eb-0242ac120002.csv',
|
||||
csvSeries: [[ file: 'gitrepo/helpers-results/quality_check/metrics_Statistics.csv', inclusionFlag: 'OFF', url: '']],
|
||||
csvSeries: [[ file: 'gitrepo/helpers-results/cl_quality_check/metrics_Statistics.csv', inclusionFlag: 'OFF', url: '']],
|
||||
group: 'metrics',
|
||||
title: 'general statistics',
|
||||
style: 'line',
|
||||
@@ -441,7 +487,7 @@ pipeline {
|
||||
numBuilds: ''])
|
||||
|
||||
plot([ csvFileName: 'plot-cddaced2-8145-11ed-a1eb-0242ac120002.csv',
|
||||
csvSeries: [[ file: 'gitrepo/helpers-results/quality_check/metrics_MessagesCat.csv', inclusionFlag: 'OFF', url: '']],
|
||||
csvSeries: [[ file: 'gitrepo/helpers-results/cl_quality_check/metrics_MessagesCat.csv', inclusionFlag: 'OFF', url: '']],
|
||||
group: 'metrics',
|
||||
title: 'quality warnings',
|
||||
style: 'stackedArea',
|
||||
@@ -449,7 +495,7 @@ pipeline {
|
||||
numBuilds: ''])
|
||||
|
||||
plot([ csvFileName: 'plot-4ceb9ee2-ca78-11ed-afa1-0242ac120002.csv',
|
||||
csvSeries: [[ file: 'gitrepo/helpers-results/complexity_check/MI.csv', inclusionFlag: 'INCLUDE_BY_STRING',exclusionValues: 'MeanMaintainability', url: '']],
|
||||
csvSeries: [[ file: 'gitrepo/helpers-results/cl_complexity_check/MI.csv', inclusionFlag: 'INCLUDE_BY_STRING',exclusionValues: 'MeanMaintainability', url: '']],
|
||||
group: 'metrics',
|
||||
title: 'maintainability',
|
||||
style: 'stackedArea',
|
||||
@@ -461,14 +507,14 @@ pipeline {
|
||||
stage("RunUnitTests") {
|
||||
steps {
|
||||
dir("gitrepo") {
|
||||
sh(". ~/TEST_ENV/bin/activate && python -m helpers --unit-test --coverage-check")
|
||||
sh(". ~/TEST_ENV/bin/activate && python -m chacha_cicd_helper --unittest --coveragecheck")
|
||||
script {
|
||||
unit_test_full_name__html=findFiles(glob: "helpers-results/unit_test_full/*.html")[0].getName()
|
||||
unit_test_full_name__html=findFiles(glob: "helpers-results/cl_unit_test_full/*.html")[0].getName()
|
||||
println unit_test_full_name__html
|
||||
unit_test_full_name__xml=findFiles(glob: "helpers-results/unit_test_full/*.xml")[0].getName()
|
||||
unit_test_full_name__xml=findFiles(glob: "helpers-results/cl_unit_test_full/*.xml")[0].getName()
|
||||
println unit_test_full_name__xml
|
||||
|
||||
coverage_report_path = "helpers-results/unit_test_coverage/test_coverage.xml"
|
||||
coverage_report_path = "helpers-results/cl_unit_test_coverage/test_coverage.xml"
|
||||
println GetCoverageValue_lines_valid(coverage_report_path)
|
||||
println GetCoverageValue_lines_covered(coverage_report_path)
|
||||
println GetCoverageValue_line_rate(coverage_report_path)
|
||||
@@ -481,14 +527,9 @@ pipeline {
|
||||
sz_full_rate = full_rate.setScale(2, RoundingMode.HALF_EVEN).toString()
|
||||
badge_coverage.setStatus(sz_full_rate)
|
||||
badge_coverage.setColor(getColorScale(full_rate))
|
||||
|
||||
//complexity = new BigDecimal( 10*GetCoverageValue_complexity(coverage_report_path))
|
||||
//sz_complexity = complexity.setScale(2, RoundingMode.HALF_EVEN).toString()
|
||||
//badge_complexity.setStatus(sz_complexity)
|
||||
//badge_quality.setColor(getColorScale_reversed(complexity))
|
||||
|
||||
|
||||
//badge_maintainability
|
||||
records = readCSV file: 'helpers-results/complexity_check/MI.csv'
|
||||
records = readCSV file: 'helpers-results/cl_complexity_check/MI.csv'
|
||||
maintainability = records[1][1]
|
||||
badge_maintainability.setStatus(maintainability)
|
||||
|
||||
@@ -503,11 +544,11 @@ pipeline {
|
||||
post {
|
||||
always {
|
||||
dir("gitrepo") {
|
||||
junit 'helpers-results/unit_test/*.xml'
|
||||
junit 'helpers-results/cl_unit_test/*.xml'
|
||||
// using cobertura format (= coverage xml format)
|
||||
publishCoverage adapters: [cobertura(mergeToOneReport: true, path: "helpers-results/unit_test_coverage/test_coverage.xml")]
|
||||
recordCoverage(tools: [[parser: 'COBERTURA', pattern: 'helpers-results/cl_unit_test_coverage/test_coverage.xml']])
|
||||
publishHTML([
|
||||
reportDir: "helpers-results/unit_test_coverage",
|
||||
reportDir: "helpers-results/cl_unit_test_coverage",
|
||||
reportFiles: "index.html",
|
||||
reportName: "coverage-report-html",
|
||||
allowMissing: false,
|
||||
@@ -515,7 +556,7 @@ pipeline {
|
||||
keepAll: true])
|
||||
|
||||
publishHTML([
|
||||
reportDir: "helpers-results/unit_test_full",
|
||||
reportDir: "helpers-results/cl_unit_test_full",
|
||||
reportFiles: unit_test_full_name__html,
|
||||
reportName: "test-reports-full",
|
||||
allowMissing: false,
|
||||
@@ -529,15 +570,14 @@ pipeline {
|
||||
stage("GenDOC") {
|
||||
steps {
|
||||
dir("gitrepo") {
|
||||
//--doc-gen-pdf
|
||||
sh(". ~/TEST_ENV/bin/activate && python -m helpers --doc-gen --doc-gen-pdf")
|
||||
sh(". ~/TEST_ENV/bin/activate && python -m chacha_cicd_helper --docgen --docgenpdf")
|
||||
}
|
||||
}
|
||||
post {
|
||||
always {
|
||||
dir("gitrepo") {
|
||||
publishHTML([
|
||||
reportDir: "helpers-results/doc_gen/site",
|
||||
reportDir: "helpers-results/cl_doc_gen/site",
|
||||
reportFiles: "index.html",
|
||||
reportName: "doc-html",
|
||||
allowMissing: false,
|
||||
@@ -569,6 +609,7 @@ pipeline {
|
||||
|from simple_rest_client.api import API
|
||||
|from simple_rest_client.resource import Resource
|
||||
|
|
||||
|
|
||||
|try:
|
||||
| from pygitversionhelper import gitversionhelper
|
||||
|except ImportError:
|
||||
@@ -615,6 +656,13 @@ pipeline {
|
||||
|ReleaseContent = "${_ReleaseContent_Title}" + "\\n" \\
|
||||
| + "\\n" \\
|
||||
| + "Reference documentation: [mkdocs page](https://chacha.ddns.net/mkdocs-web/${_PROJECT_USER_NAME}/${PY_PROJECT_NAME}/${_GIT_BRANCH}/${PY_PROJECT_VERSION_STRIPPED}/) "
|
||||
|
|
||||
|Changelog='''${CHANGELOG}'''
|
||||
|
|
||||
|ReleaseContent = ReleaseContent + "\\n"+ "\\n"+ "## Changelog:\\n" + Changelog
|
||||
|
|
||||
|if not Changelog:
|
||||
| ReleaseContent = ReleaseContent + "code/project maintainance"
|
||||
|
|
||||
|data={
|
||||
| "body": ReleaseContent,
|
||||
@@ -634,11 +682,11 @@ pipeline {
|
||||
|
|
||||
|data = {
|
||||
| "name": "Documentation (pdf)",
|
||||
| 'attachment': ("${PY_PROJECT_NAME}_${PY_PROJECT_VERSION}_UserManual.pdf", open("helpers-results/doc_gen/site/pdf/manual.pdf", 'rb')),
|
||||
| 'attachment': ("${PY_PROJECT_NAME}_${PY_PROJECT_VERSION}_UserManual.pdf", open("helpers-results/cl_doc_gen/site/pdf/manual.pdf", 'rb')),
|
||||
|}
|
||||
|GiteaApi.assets.post("${_PROJECT_USER_NAME}","${PY_PROJECT_NAME}",new_release_id,files=data)
|
||||
|
|
||||
|shutil.make_archive("doc", 'zip', "helpers-results/doc_gen/site")
|
||||
|shutil.make_archive("doc", 'zip', "helpers-results/cl_doc_gen/site")
|
||||
|reqData={
|
||||
| "SECRET": "${MKDOCSTOKEN}",
|
||||
| "USER": "${_PROJECT_USER_NAME}",
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
|
||||
|
||||
# pyChangeLogHelper
|
||||
# pyChangelogFactory
|
||||
|
||||
A simple changelog formater that consume raw changes list text and produce nice pre-formated changelogs.
|
||||
The input data mainly aim to be a merged commit report.
|
||||
|
||||
@@ -2,14 +2,15 @@
|
||||
<launchConfiguration type="org.python.pydev.debug.regularLaunchConfigurationType">
|
||||
<booleanAttribute key="org.eclipse.debug.core.ATTR_FORCE_SYSTEM_CONSOLE_ENCODING" value="false"/>
|
||||
<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
|
||||
<listEntry value="/${project_name}/helpers"/>
|
||||
<listEntry value="/pychangelogfactory/helpers_proxy"/>
|
||||
</listAttribute>
|
||||
<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
|
||||
<listEntry value="2"/>
|
||||
</listAttribute>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:pychangelogfactory/helpers}"/>
|
||||
<stringAttribute key="org.eclipse.debug.ui.ATTR_CONSOLE_ENCODING" value="UTF-8"/>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:pychangelogfactory/helpers_proxy}"/>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_OTHER_WORKING_DIRECTORY" value=""/>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="--complexity-check"/>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="--complexitycheck"/>
|
||||
<stringAttribute key="org.python.pydev.debug.ATTR_INTERPRETER" value="__default"/>
|
||||
<stringAttribute key="org.python.pydev.debug.ATTR_PROJECT" value="pychangelogfactory"/>
|
||||
<stringAttribute key="process_factory_id" value="org.python.pydev.debug.processfactory.PyProcessFactory"/>
|
||||
|
||||
@@ -2,17 +2,15 @@
|
||||
<launchConfiguration type="org.python.pydev.debug.regularLaunchConfigurationType">
|
||||
<booleanAttribute key="org.eclipse.debug.core.ATTR_FORCE_SYSTEM_CONSOLE_ENCODING" value="false"/>
|
||||
<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
|
||||
<listEntry value="/${project_name}/helpers"/>
|
||||
<listEntry value="/pychangelogfactory/helpers_proxy"/>
|
||||
</listAttribute>
|
||||
<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
|
||||
<listEntry value="2"/>
|
||||
</listAttribute>
|
||||
<mapAttribute key="org.eclipse.debug.core.environmentVariables">
|
||||
<mapEntry key="PATH" value="C:\Program Files\GTK3-Runtime Win64\bin"/>
|
||||
</mapAttribute>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:pychangelogfactory/helpers}"/>
|
||||
<stringAttribute key="org.eclipse.debug.ui.ATTR_CONSOLE_ENCODING" value="UTF-8"/>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:pychangelogfactory/helpers_proxy}"/>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_OTHER_WORKING_DIRECTORY" value=""/>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="--doc-gen --doc-gen-pdf"/>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="--docgen --docgenpdf"/>
|
||||
<stringAttribute key="org.python.pydev.debug.ATTR_INTERPRETER" value="__default"/>
|
||||
<stringAttribute key="org.python.pydev.debug.ATTR_PROJECT" value="pychangelogfactory"/>
|
||||
<stringAttribute key="process_factory_id" value="org.python.pydev.debug.processfactory.PyProcessFactory"/>
|
||||
|
||||
@@ -2,14 +2,15 @@
|
||||
<launchConfiguration type="org.python.pydev.debug.regularLaunchConfigurationType">
|
||||
<booleanAttribute key="org.eclipse.debug.core.ATTR_FORCE_SYSTEM_CONSOLE_ENCODING" value="false"/>
|
||||
<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
|
||||
<listEntry value="/${project_name}/helpers"/>
|
||||
<listEntry value="/pychangelogfactory/helpers_proxy"/>
|
||||
</listAttribute>
|
||||
<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
|
||||
<listEntry value="2"/>
|
||||
</listAttribute>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:pychangelogfactory/helpers}"/>
|
||||
<stringAttribute key="org.eclipse.debug.ui.ATTR_CONSOLE_ENCODING" value="UTF-8"/>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:pychangelogfactory/helpers_proxy}"/>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_OTHER_WORKING_DIRECTORY" value=""/>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="--type-check --quality-check"/>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="--qualitycheck"/>
|
||||
<stringAttribute key="org.python.pydev.debug.ATTR_INTERPRETER" value="__default"/>
|
||||
<stringAttribute key="org.python.pydev.debug.ATTR_PROJECT" value="pychangelogfactory"/>
|
||||
<stringAttribute key="process_factory_id" value="org.python.pydev.debug.processfactory.PyProcessFactory"/>
|
||||
|
||||
@@ -2,14 +2,15 @@
|
||||
<launchConfiguration type="org.python.pydev.debug.regularLaunchConfigurationType">
|
||||
<booleanAttribute key="org.eclipse.debug.core.ATTR_FORCE_SYSTEM_CONSOLE_ENCODING" value="false"/>
|
||||
<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
|
||||
<listEntry value="/${project_name}/helpers"/>
|
||||
<listEntry value="/pychangelogfactory/helpers_proxy"/>
|
||||
</listAttribute>
|
||||
<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
|
||||
<listEntry value="2"/>
|
||||
</listAttribute>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${project_loc}/helpers"/>
|
||||
<stringAttribute key="org.eclipse.debug.ui.ATTR_CONSOLE_ENCODING" value="UTF-8"/>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:pychangelogfactory/helpers_proxy}"/>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_OTHER_WORKING_DIRECTORY" value=""/>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="--changelog-gen"/>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="--typecheck"/>
|
||||
<stringAttribute key="org.python.pydev.debug.ATTR_INTERPRETER" value="__default"/>
|
||||
<stringAttribute key="org.python.pydev.debug.ATTR_PROJECT" value="pychangelogfactory"/>
|
||||
<stringAttribute key="process_factory_id" value="org.python.pydev.debug.processfactory.PyProcessFactory"/>
|
||||
@@ -2,14 +2,15 @@
|
||||
<launchConfiguration type="org.python.pydev.debug.regularLaunchConfigurationType">
|
||||
<booleanAttribute key="org.eclipse.debug.core.ATTR_FORCE_SYSTEM_CONSOLE_ENCODING" value="false"/>
|
||||
<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
|
||||
<listEntry value="/${project_name}/helpers"/>
|
||||
<listEntry value="/pychangelogfactory/helpers_proxy"/>
|
||||
</listAttribute>
|
||||
<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
|
||||
<listEntry value="2"/>
|
||||
</listAttribute>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:pychangelogfactory/helpers}"/>
|
||||
<stringAttribute key="org.eclipse.debug.ui.ATTR_CONSOLE_ENCODING" value="UTF-8"/>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:pychangelogfactory/helpers_proxy}"/>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_OTHER_WORKING_DIRECTORY" value=""/>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="--unit-test --coverage-check"/>
|
||||
<stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="--unittest --coveragecheck"/>
|
||||
<stringAttribute key="org.python.pydev.debug.ATTR_INTERPRETER" value="__default"/>
|
||||
<stringAttribute key="org.python.pydev.debug.ATTR_PROJECT" value="pychangelogfactory"/>
|
||||
<stringAttribute key="process_factory_id" value="org.python.pydev.debug.processfactory.PyProcessFactory"/>
|
||||
|
||||
@@ -42,7 +42,7 @@ From master git repository:
|
||||
|
||||
### Sample code
|
||||
``` py
|
||||
from pychangelogfactory import ChangeLogFactory
|
||||
from pychangelogfactory import ChangelogFactory
|
||||
|
||||
raw_changelog = (
|
||||
"feat: add a nice feature to the project\n"
|
||||
@@ -52,7 +52,7 @@ raw_changelog = (
|
||||
"improve core performances by reducing complexity\n"
|
||||
"some random changes in the text content\n"
|
||||
)
|
||||
hdlr = ChangeLogFactory()
|
||||
hdlr = ChangelogFactory()
|
||||
hdlr.ProcessFullChangelog(self.raw_changelog)
|
||||
changelog = hdlr.RenderFullChangelog()
|
||||
print(changelog)
|
||||
@@ -61,13 +61,13 @@ print(changelog)
|
||||
#### Or shorted version:
|
||||
|
||||
``` py
|
||||
hdlr = ChangeLogFactory(self.raw_changelog)
|
||||
hdlr = ChangelogFactory(self.raw_changelog)
|
||||
changelog = hdlr.RenderFullChangelog()
|
||||
```
|
||||
#### Or one-liner version:
|
||||
|
||||
``` py
|
||||
changelog = ChangeLogFactory(self.raw_changelog).RenderFullChangelog()
|
||||
changelog = ChangelogFactory(self.raw_changelog).RenderFullChangelog()
|
||||
```
|
||||
|
||||
### Output(Raw)
|
||||
@@ -97,7 +97,7 @@ changelog = ChangeLogFactory(self.raw_changelog).RenderFullChangelog()
|
||||
### Options
|
||||
#### Display unknown messages types
|
||||
``` py
|
||||
from pychangelogfactory import ChangeLogFormater
|
||||
from pychangelogfactory import ChangelogFormater
|
||||
|
||||
raw_changelog = (
|
||||
"feat: add a nice feature to the project\n"
|
||||
@@ -107,7 +107,7 @@ raw_changelog = (
|
||||
"improve core performances by reducing complexity\n"
|
||||
"some random changes in the text content\n"
|
||||
)
|
||||
changelog = ChangeLogFactory(self.raw_changelog).RenderFullChangelog(include_unknown=True)
|
||||
changelog = ChangelogFactory(self.raw_changelog).RenderFullChangelog(include_unknown=True)
|
||||
print(changelog)
|
||||
```
|
||||
### Output (rendered)
|
||||
@@ -125,34 +125,34 @@ print(changelog)
|
||||
|
||||
## Supported types
|
||||
|
||||
| Type/Tag | Priority | Keywords | Title |
|
||||
|-----------|----------|----------------------------------------|-------------------------------------------------------|
|
||||
| break | 20 | break | :rotating_light: Breaking changes :rotating_light: : |
|
||||
| feat | 20 | feat, new, create, add | Features :sparkles: : |
|
||||
| fix | 0 | fix, issue, problem | Fixes :wrench: : |
|
||||
| security | 20 | safe, leak | Security :shield: : |
|
||||
| chore | 10 | task, refactor, build, better, improve | Chore :building_construction: : |
|
||||
| perf | 15 | fast, perf | Performance Enhancements :rocket: : |
|
||||
| wip | 0 | temp | Work in progress changes :construction: : |
|
||||
| doc | 0 | doc, manual | Documentations :book: : |
|
||||
| style | 5 | beautify | Style :art: : |
|
||||
| refactor | 0 | | Refactorings :recycle: : |
|
||||
| ci | 0 | jenkins, git | Continuous Integration :cyclone: : |
|
||||
| test | -5 | unittest, check, testing | Testings :vertical_traffic_light: : |
|
||||
| build | 0 | compile, version | Builds :package: : |
|
||||
| revert | 0 | revert, fallback | Reverts :back: : |
|
||||
| other | -20 | | Others :question: : |
|
||||
| Type/Tag | Priority | Keywords | Title | Class Name |
|
||||
|-----------|----------|----------------------------------------|-------------------------------------------------------|-------------------------------|
|
||||
| break | 20 | break | :rotating_light: Breaking changes :rotating_light: : | `ChangelogFormater_break` |
|
||||
| feat | 20 | feat, new, create, add | Features :sparkles: : | `ChangelogFormater_feat` |
|
||||
| fix | 0 | fix, issue, problem | Fixes :wrench: : | `ChangelogFormater_fix` |
|
||||
| security | 20 | safe, leak | Security :shield: : | `ChangelogFormater_security` |
|
||||
| chore | 10 | task, refactor, build, better, improve | Chore :building_construction: : | `ChangelogFormater_chore` |
|
||||
| perf | 15 | fast, perf | Performance Enhancements :rocket: : | `ChangelogFormater_perf` |
|
||||
| wip | 0 | temp | Work in progress changes :construction: : | `ChangelogFormater_wip` |
|
||||
| doc | 0 | doc, manual | Documentations :book: : | `ChangelogFormater_wip` |
|
||||
| style | 5 | beautify | Style :art: : | `ChangelogFormater_style` |
|
||||
| refactor | 0 | | Refactorings :recycle: : | `ChangelogFormater_refactor` |
|
||||
| ci | 0 | jenkins, git | Continuous Integration :cyclone: : | `ChangelogFormater_ci` |
|
||||
| test | -5 | unittest, check, testing | Testings :vertical_traffic_light: : | `ChangelogFormater_test` |
|
||||
| build | 0 | compile, version | Builds :package: : | `ChangelogFormater_build` |
|
||||
| revert | 0 | revert, fallback | Reverts :back: : | `ChangelogFormater_revert` |
|
||||
| other | -20 | | Others :question: : | `ChangelogFormater_others` |
|
||||
|
||||
## Add new types
|
||||
|
||||
New formaters can be easily added by subclassing `ChangeLogFormater`:
|
||||
New formaters can be easily added by subclassing `ChangelogFormater`:
|
||||
|
||||
### Inject custom formater locally (prefered way)
|
||||
|
||||
``` py
|
||||
from pychangelogfactory import ChangeLogFormater,ChangeLogFactory
|
||||
from pychangelogfactory import ChangelogFormater,ChangelogFactory
|
||||
|
||||
class ChangeLogFormater_others(ChangeLogFormater):
|
||||
class ChangelogFormater_others(ChangelogFormater):
|
||||
"""My formater"""
|
||||
|
||||
prefix: str = "mytag"
|
||||
@@ -160,18 +160,18 @@ class ChangeLogFormater_others(ChangeLogFormater):
|
||||
keywords: list[str] = ["foo","42"]
|
||||
priority: int = 10
|
||||
|
||||
hdlr = ChangeLogFactory()
|
||||
hdlr.RegisterFormater(ChangeLogFormater_others)
|
||||
hdlr = ChangelogFactory()
|
||||
hdlr.RegisterFormater(ChangelogFormater_others)
|
||||
...
|
||||
```
|
||||
|
||||
### Inject custom formater module-wide
|
||||
|
||||
``` py
|
||||
from pychangelogfactory import ChangeLogFormater,ChangeLogFormaterRecordType
|
||||
from pychangelogfactory import ChangelogFormater,ChangelogFormaterRecordType
|
||||
|
||||
@ChangeLogFormaterRecordType
|
||||
class ChangeLogFormater_others(ChangeLogFormater):
|
||||
@ChangelogFormaterRecordType
|
||||
class ChangelogFormater_others(ChangelogFormater):
|
||||
"""My formater"""
|
||||
|
||||
prefix: str = "mytag"
|
||||
@@ -179,12 +179,12 @@ class ChangeLogFormater_others(ChangeLogFormater):
|
||||
keywords: list[str] = ["foo","42"]
|
||||
priority: int = 10
|
||||
|
||||
hdlr = ChangeLogFactory()
|
||||
hdlr = ChangelogFactory()
|
||||
...
|
||||
```
|
||||
|
||||
/// note | Scope
|
||||
This will register your new formater for all next new factories
|
||||
This will register your new formater for all next new factories, maybe not only in your own code !
|
||||
///
|
||||
### Test
|
||||
|
||||
@@ -193,7 +193,7 @@ raw_changelog = ("mytag: add a nice feature to the project\n"
|
||||
"foo modification in my file\n"
|
||||
"need 42 coffee\n"
|
||||
)
|
||||
hdlr = ChangeLogFactory(raw_changelog)
|
||||
hdlr = ChangelogFactory(raw_changelog)
|
||||
changelog = hdlr.RenderFullChangelog(include_unknown=True)
|
||||
print(changelog)
|
||||
```
|
||||
@@ -207,5 +207,24 @@ print(changelog)
|
||||
> need 42 coffee
|
||||
|
||||
|
||||
|
||||
|
||||
### Revert changes
|
||||
#### Reset to original list class-wise (all modules):
|
||||
``` py
|
||||
ChangelogFactory.ResetBaseFormaterList()
|
||||
...
|
||||
```
|
||||
#### Reset to original list instance-wise:
|
||||
``` py
|
||||
hdlr = ChangelogFactory()
|
||||
hdlr.ResetFormaterList()
|
||||
...
|
||||
```
|
||||
#### Removing a specific formater:
|
||||
``` py
|
||||
hdlr = ChangelogFactory()
|
||||
hdlr.unRegisterFormater(ChangelogFormater_others)
|
||||
...
|
||||
```
|
||||
/// warning
|
||||
There is no way to remove a specific formater class-wise (all modules) except using ResetFormaterList().
|
||||
///
|
||||
|
||||
1
helpers/.gitignore
vendored
1
helpers/.gitignore
vendored
@@ -1 +0,0 @@
|
||||
/.mypy_cache/
|
||||
@@ -1,7 +0,0 @@
|
||||
# pyChaChaDummyProject (c) by chacha
|
||||
#
|
||||
# pyChaChaDummyProject is licensed under a
|
||||
# Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Unported License.
|
||||
#
|
||||
# You should have received a copy of the license along with this
|
||||
# work. If not, see <https://creativecommons.org/licenses/by-nc-sa/4.0/>.
|
||||
@@ -1,116 +0,0 @@
|
||||
# pyChaChaDummyProject (c) by chacha
|
||||
#
|
||||
# pyChaChaDummyProject is licensed under a
|
||||
# Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Unported License.
|
||||
#
|
||||
# You should have received a copy of the license along with this
|
||||
# work. If not, see <https://creativecommons.org/licenses/by-nc-sa/4.0/>.
|
||||
|
||||
from __future__ import annotations
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
from pathlib import Path
|
||||
import tomli
|
||||
import argparse
|
||||
import os
|
||||
import logging
|
||||
import sys
|
||||
|
||||
if __package__ == "helpers":
|
||||
# when calling the module from: > python -m helpers
|
||||
from .types_check import types_check
|
||||
from .quality_check import quality_check
|
||||
from .unit_test import unit_test
|
||||
from .doc_gen import doc_gen
|
||||
from .changelog_gen import changelog_gen
|
||||
from .complexity_check import complexity_check
|
||||
else:
|
||||
# when calling the __main__.py file (from IDE)
|
||||
from helpers.types_check import types_check
|
||||
from helpers.quality_check import quality_check
|
||||
from helpers.unit_test import unit_test
|
||||
from helpers.doc_gen import doc_gen
|
||||
from helpers.changelog_gen import changelog_gen
|
||||
from helpers.complexity_check import complexity_check
|
||||
|
||||
logging.getLogger().setLevel(logging.INFO)
|
||||
|
||||
if __name__ == "__main__":
|
||||
project_rootdir_path = Path(__file__).parent.parent.absolute()
|
||||
|
||||
with open(project_rootdir_path / "pyproject.toml", mode="rb") as fp:
|
||||
pyproject = tomli.load(fp)
|
||||
|
||||
parser = argparse.ArgumentParser(
|
||||
prog="continuous-integration-helper", description="A tiny set of scripts to help continous integration on python"
|
||||
)
|
||||
|
||||
parser.add_argument("-tc", "--type-check", dest="typecheck", action="store_true", help="enable static typing check")
|
||||
|
||||
parser.add_argument("-ut", "--unit-test", dest="unittest", action="store_true", help="enable unit-test")
|
||||
parser.add_argument(
|
||||
"-cc", "--coverage-check", dest="coveragecheck", action="store_true", help="enable unit-test coverage check (requires unit-test)"
|
||||
)
|
||||
|
||||
parser.add_argument("-qc", "--quality-check", dest="qualitycheck", action="store_true", help="enable code quality check")
|
||||
|
||||
parser.add_argument("-dg", "--doc-gen", dest="docgen", action="store_true", help="enable documentation generation using MkDoc")
|
||||
parser.add_argument(
|
||||
"-pdf", "--doc-gen-pdf", dest="docgenpdf", action="store_true", help="enable pdf documentation export (requires doc-gen)"
|
||||
)
|
||||
|
||||
parser.add_argument("-clg", "--changelog-gen", dest="changeloggen", action="store_true", help="enable changelog generation")
|
||||
|
||||
parser.add_argument("-cpc", "--complexity-check", dest="complexitycheck", action="store_true", help="enable complexity check")
|
||||
|
||||
args = parser.parse_args()
|
||||
|
||||
##################################
|
||||
# Dev / Debug forced toogles
|
||||
#
|
||||
# --------------------------------
|
||||
#
|
||||
# args.typecheck = True
|
||||
# args.qualitycheck = True
|
||||
# args.unittest = True
|
||||
# args.coveragecheck = True
|
||||
# args.docgen = True
|
||||
# args.docgenpdf = True
|
||||
# args.changeloggen = True
|
||||
# args.complexitycheck = True
|
||||
|
||||
helpers = []
|
||||
if args.typecheck == True:
|
||||
helpers.append(types_check)
|
||||
|
||||
if args.unittest == True:
|
||||
helpers.append(unit_test)
|
||||
|
||||
if args.coveragecheck == True:
|
||||
if args.unittest == True:
|
||||
unit_test.enable_coverage_check = True
|
||||
else:
|
||||
raise RuntimeError("unit-test is required to enable coverage-check")
|
||||
|
||||
if args.qualitycheck == True:
|
||||
helpers.append(quality_check)
|
||||
|
||||
if args.docgen == True:
|
||||
helpers.append(doc_gen)
|
||||
|
||||
if args.docgenpdf == True:
|
||||
if args.docgen == True:
|
||||
doc_gen.enable_gen_pdf = True
|
||||
else:
|
||||
raise RuntimeError("doc-gen is required to enable doc-gen-pdf")
|
||||
|
||||
if args.changeloggen == True:
|
||||
helpers.append(changelog_gen)
|
||||
|
||||
if args.complexitycheck == True:
|
||||
helpers.append(complexity_check)
|
||||
|
||||
for helper in helpers:
|
||||
helper.set_context(project_rootdir_path, pyproject)
|
||||
helper.reset_result_dir()
|
||||
helper.do_job()
|
||||
@@ -1,23 +0,0 @@
|
||||
# pyChaChaDummyProject (c) by chacha
|
||||
#
|
||||
# pyChaChaDummyProject is licensed under a
|
||||
# Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Unported License.
|
||||
#
|
||||
# You should have received a copy of the license along with this
|
||||
# work. If not, see <https://creativecommons.org/licenses/by-nc-sa/4.0/>.
|
||||
|
||||
from __future__ import annotations
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
# from pathlib import Path
|
||||
# import os
|
||||
# import datetime
|
||||
|
||||
|
||||
from .helper_base import helper_base
|
||||
|
||||
|
||||
class changelog_gen(helper_base):
|
||||
@classmethod
|
||||
def do_job(cls):
|
||||
pass
|
||||
@@ -1,70 +0,0 @@
|
||||
# pyChaChaDummyProject (c) by chacha
|
||||
#
|
||||
# pyChaChaDummyProject is licensed under a
|
||||
# Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Unported License.
|
||||
#
|
||||
# You should have received a copy of the license along with this
|
||||
# work. If not, see <https://creativecommons.org/licenses/by-nc-sa/4.0/>.
|
||||
|
||||
from __future__ import annotations
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
# from pathlib import Path
|
||||
# import os
|
||||
import statistics
|
||||
import csv
|
||||
from json import loads as JSON_LOADS
|
||||
from radon.complexity import cc_rank, SCORE
|
||||
from radon.cli import Config
|
||||
from radon.cli.harvest import CCHarvester, HCHarvester, MIHarvester
|
||||
|
||||
from .helper_base import helper_withresults_base
|
||||
from pprint import pprint
|
||||
|
||||
|
||||
class complexity_check(helper_withresults_base):
|
||||
@classmethod
|
||||
def do_job(cls):
|
||||
config = Config(
|
||||
exclude="__init__\.py",
|
||||
ignore=None,
|
||||
order=SCORE,
|
||||
show_closures=False,
|
||||
no_assert=True,
|
||||
min="A",
|
||||
max="F",
|
||||
multi=False,
|
||||
)
|
||||
|
||||
h = MIHarvester([str(_) for _ in sorted((cls.project_rootdir_path / "src").rglob("*.py"))], config).as_json()
|
||||
res = JSON_LOADS(h)
|
||||
|
||||
with open(cls.get_result_dir() / "MI.json", "w", newline="") as oFile:
|
||||
oFile.write(h)
|
||||
|
||||
mean = statistics.mean(_["mi"] for _ in res.values())
|
||||
|
||||
if mean >= 65:
|
||||
rank = "A+"
|
||||
elif mean >= 20:
|
||||
rank = "A"
|
||||
elif mean >= 10:
|
||||
rank = "B"
|
||||
else:
|
||||
rank = "C"
|
||||
|
||||
RES_MI = {"MeanMaintainability": mean, "MaintainabilityIndex": rank}
|
||||
with open(cls.get_result_dir() / "MI.csv", "w", newline="") as oFile:
|
||||
writer = csv.DictWriter(oFile, fieldnames=RES_MI.keys())
|
||||
writer.writeheader()
|
||||
writer.writerow(RES_MI)
|
||||
|
||||
config = Config(exclude=None, ignore=None, order=SCORE, show_closures=False, no_assert=True, min="A", max="F", multi=False)
|
||||
h = CCHarvester([str(_) for _ in sorted((cls.project_rootdir_path / "src").rglob("*.py"))], config).as_json()
|
||||
with open(cls.get_result_dir() / "CC.json", "w", newline="") as oFile:
|
||||
oFile.write(h)
|
||||
|
||||
config = Config(exclude=None, ignore=None, order=SCORE, show_closures=False, no_assert=True, min="A", max="F", by_function=None)
|
||||
h = HCHarvester([str(_) for _ in sorted((cls.project_rootdir_path / "src").rglob("*.py"))], config).as_json()
|
||||
with open(cls.get_result_dir() / "HC.json", "w", newline="") as oFile:
|
||||
oFile.write(h)
|
||||
@@ -1,98 +0,0 @@
|
||||
# pyChaChaDummyProject (c) by chacha
|
||||
#
|
||||
# pyChaChaDummyProject is licensed under a
|
||||
# Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Unported License.
|
||||
#
|
||||
# You should have received a copy of the license along with this
|
||||
# work. If not, see <https://creativecommons.org/licenses/by-nc-sa/4.0/>.
|
||||
|
||||
from __future__ import annotations
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
import shutil
|
||||
import os
|
||||
import sys
|
||||
import subprocess
|
||||
from pathlib import Path
|
||||
from distutils.dir_util import copy_tree
|
||||
|
||||
import yaml
|
||||
|
||||
try:
|
||||
from yaml import CLoader as Loader, CDumper as Dumper
|
||||
except ImportError:
|
||||
from yaml import Loader, Dumper
|
||||
|
||||
from .helper_base import helper_withresults_base
|
||||
|
||||
|
||||
class doc_gen(helper_withresults_base):
|
||||
enable_gen_pdf: bool = False
|
||||
|
||||
@classmethod
|
||||
def do_job(cls):
|
||||
|
||||
# create doc root dir
|
||||
doc_path = cls.project_rootdir_path / "docs"
|
||||
cls._reset_dir(doc_path)
|
||||
|
||||
site_path = cls.get_result_dir() / "site"
|
||||
cls._reset_dir(site_path)
|
||||
|
||||
# copy files from main project dir
|
||||
shutil.copyfile(str(cls.project_rootdir_path / "README.md"), str(doc_path / "README.md"))
|
||||
shutil.copyfile(str(cls.project_rootdir_path / "LICENSE.md"), str(doc_path / "LICENSE.md"))
|
||||
|
||||
# copy files from static-doc dir
|
||||
copy_tree(str(cls.project_rootdir_path / "docs-static"), str(doc_path))
|
||||
|
||||
# generating API doc + nav from python docstrings
|
||||
reference_path = doc_path / "reference"
|
||||
cls._reset_dir(reference_path)
|
||||
|
||||
for path in sorted((cls.project_rootdir_path / "src").rglob("*.py")):
|
||||
module_path = path.relative_to(cls.project_rootdir_path / "src").with_suffix("")
|
||||
doc_path = path.relative_to(cls.project_rootdir_path / "src").with_suffix(".md")
|
||||
full_doc_path = Path(reference_path, doc_path)
|
||||
|
||||
parts = list(module_path.parts)
|
||||
|
||||
if parts[-1] == "__init__":
|
||||
parts = parts[:-1]
|
||||
elif parts[-1] == "__main__":
|
||||
continue
|
||||
|
||||
cls._reset_dir(os.path.dirname(full_doc_path))
|
||||
with open(full_doc_path, "w+") as fd:
|
||||
identifier = "src." + ".".join(parts)
|
||||
print("::: " + identifier, file=fd)
|
||||
|
||||
cmdopts = [f"{sys.executable}", "-m", "mkdocs", "-v", "build", "--site-dir", str(site_path), "--clean"]
|
||||
|
||||
# little hack here, to enable / disable pdf generation using own class config
|
||||
# => reason is mkdocs seems to try loading the plugin even if we disable it, so we need to
|
||||
# manually process the configuration file.
|
||||
with open(cls.project_rootdir_path / "mkdocs.yml", "r") as mkdocsCfgFile:
|
||||
mkdocsCfg = yaml.load(mkdocsCfgFile, Loader=yaml.Loader)
|
||||
|
||||
if "plugins" in mkdocsCfg:
|
||||
mkdocsCfg["plugins"] = [_ for _ in mkdocsCfg["plugins"] if (not isinstance(_, dict) or "with-pdf" not in _.keys())]
|
||||
|
||||
if cls.enable_gen_pdf == True:
|
||||
mkdocsCfg["plugins"].append(
|
||||
{
|
||||
"with-pdf": {
|
||||
"cover_subtitle": "User Manual",
|
||||
"cover_logo": str(cls.project_rootdir_path / "docs-static" / "Library.jpg"),
|
||||
"verbose": False,
|
||||
"exclude_pages": ["LICENSE"],
|
||||
"output_path": str(site_path / "pdf" / "manual.pdf"),
|
||||
}
|
||||
}
|
||||
)
|
||||
with open(cls.project_rootdir_path / "mkdocs.yml", "w") as mkdocsCfgFile:
|
||||
mkdocsCfgFile.write(yaml.dump(mkdocsCfg, Dumper=Dumper, default_flow_style=False, sort_keys=False))
|
||||
|
||||
res = cls.run_cmd(cmdopts)
|
||||
print(res.decode())
|
||||
print(" !! done")
|
||||
@@ -1,74 +0,0 @@
|
||||
# pyChaChaDummyProject (c) by chacha
|
||||
#
|
||||
# pyChaChaDummyProject is licensed under a
|
||||
# Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Unported License.
|
||||
#
|
||||
# You should have received a copy of the license along with this
|
||||
# work. If not, see <https://creativecommons.org/licenses/by-nc-sa/4.0/>.
|
||||
|
||||
from __future__ import annotations
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
from abc import ABC, abstractmethod
|
||||
import os
|
||||
from pathlib import Path
|
||||
import subprocess
|
||||
|
||||
if TYPE_CHECKING: # Only imports the below statements during type checking
|
||||
from typing import Union
|
||||
|
||||
|
||||
class helper_base(ABC):
|
||||
project_rootdir_path: Union[Path, None] = None
|
||||
pyproject: Union[dict, None] = None
|
||||
current_dir: Union[Path, None] = None
|
||||
|
||||
@classmethod
|
||||
def set_context(cls, project_rootdir_path: Path, pyproject: dict):
|
||||
cls.project_rootdir_path = project_rootdir_path
|
||||
cls.pyproject = pyproject
|
||||
cls.current_dir = Path(__file__).parent.absolute()
|
||||
|
||||
@classmethod
|
||||
def get_result_dir(cls):
|
||||
return None
|
||||
|
||||
@staticmethod
|
||||
def _reset_dir(dirpath: Path):
|
||||
dirpath = Path(dirpath)
|
||||
if not os.path.exists(dirpath):
|
||||
os.makedirs(dirpath)
|
||||
[f.unlink() for f in Path(dirpath).glob("*") if f.is_file()]
|
||||
|
||||
@classmethod
|
||||
def reset_result_dir(cls):
|
||||
result_dir = cls.get_result_dir()
|
||||
if result_dir != None:
|
||||
cls._reset_dir(result_dir)
|
||||
|
||||
@classmethod
|
||||
@abstractmethod
|
||||
def do_job(cls):
|
||||
raise NotImplementedError()
|
||||
|
||||
@classmethod
|
||||
def run_cmd_(cls, cmdarray):
|
||||
process = subprocess.run(cmdarray, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True, check=True)
|
||||
return process.stdout
|
||||
|
||||
@classmethod
|
||||
def run_cmd(cls, cmdarray):
|
||||
p = subprocess.run(cmdarray, capture_output=True)
|
||||
print(p.stdout)
|
||||
print(p.stderr)
|
||||
return p.stdout
|
||||
|
||||
|
||||
class helper_withresults_base(helper_base):
|
||||
helper_results_dir: Union[Path, None] = None
|
||||
|
||||
@classmethod
|
||||
def get_result_dir(cls):
|
||||
if cls.helper_results_dir == None:
|
||||
cls.helper_results_dir = cls.__name__
|
||||
return Path(__file__).parent.parent.absolute() / "helpers-results" / cls.helper_results_dir
|
||||
@@ -1,246 +0,0 @@
|
||||
# pyChaChaDummyProject (c) by chacha
|
||||
#
|
||||
# pyChaChaDummyProject is licensed under a
|
||||
# Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Unported License.
|
||||
#
|
||||
# You should have received a copy of the license along with this
|
||||
# work. If not, see <https://creativecommons.org/licenses/by-nc-sa/4.0/>.
|
||||
|
||||
from __future__ import annotations
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
from contextlib import redirect_stdout
|
||||
from io import StringIO
|
||||
import re
|
||||
import json
|
||||
from enum import Enum
|
||||
from contextlib import suppress
|
||||
import sys
|
||||
import pandas
|
||||
import csv
|
||||
import copy
|
||||
|
||||
from pylint.lint import Run as pylint_Run
|
||||
import pylint_json2html
|
||||
|
||||
from .helper_base import helper_withresults_base
|
||||
|
||||
|
||||
class PyLintMetricNotFound(Warning):
|
||||
pass
|
||||
|
||||
|
||||
class quality_check(helper_withresults_base):
|
||||
PylintMessageList = dict()
|
||||
|
||||
@classmethod
|
||||
def GetPylintMessageList(cls):
|
||||
Messagelist = dict()
|
||||
regex = r"^:([a-zA-Z-]+) \(([^\)]+)\)"
|
||||
for line in cls.run_cmd([sys.executable, "-m", "pylint", "--list-msgs"]).splitlines():
|
||||
if res := re.search(regex, line.decode()):
|
||||
Messagelist[res.group(1)] = res.group(2)
|
||||
cls.PylintMessageList = Messagelist
|
||||
|
||||
@staticmethod
|
||||
def TryExtractPYReportMetric(line: str, tag: str):
|
||||
regex = f"^(?:\|{tag}\s*\|)(\d+)(?=\s*|)"
|
||||
if res := re.search(regex, line):
|
||||
return float(res.group(1))
|
||||
raise PyLintMetricNotFound()
|
||||
|
||||
@classmethod
|
||||
def do_job(cls):
|
||||
print("checking code quality ...")
|
||||
cls.GetPylintMessageList()
|
||||
|
||||
RES_all = dict()
|
||||
with StringIO() as StdOutput:
|
||||
JsonContent = ""
|
||||
with redirect_stdout(StdOutput):
|
||||
pylint_Run(
|
||||
[
|
||||
"--load-plugins=pylint.extensions.mccabe",
|
||||
"--output-format=json,parseable",
|
||||
"--disable=invalid-name",
|
||||
"--ignore=_version.py",
|
||||
"--reports=y",
|
||||
"--score=yes",
|
||||
"--max-line-length=140",
|
||||
"src." + cls.pyproject["project"]["name"],
|
||||
],
|
||||
exit=False,
|
||||
)
|
||||
|
||||
with open(cls.get_result_dir() / "report.json", "w+", encoding="utf-8") as Outfile:
|
||||
# hacky way of exctracting json + having overall score...
|
||||
class TScanState(Enum):
|
||||
TEXT_REPORT = 1
|
||||
JSON_REPORT = 2
|
||||
OTHER_REPORT_START = 3
|
||||
OTHER_REPORT_STATISTICS = 4
|
||||
OTHER_REPORT_METRICS = 5
|
||||
OTHER_REPORT_DUPLICATION = 6
|
||||
OTHER_REPORT_MESSAGES_CAT = 7
|
||||
OTHER_REPORT_MESSAGES = 8
|
||||
OTHER_REPORT_END = 99
|
||||
|
||||
RES_all["Statistics"] = dict()
|
||||
RES_all["RawMetrics"] = dict()
|
||||
RES_all["RawMetricsPercent"] = dict()
|
||||
RES_all["Duplication"] = dict()
|
||||
RES_all["MessagesCat"] = dict()
|
||||
RES_all["Messages"] = dict()
|
||||
RES_all["GlobalScore"] = -999
|
||||
RES_all["NbAnalysedStatments"] = -999
|
||||
RES_all["NbAnalysedLines"] = -999
|
||||
|
||||
ScanState = TScanState.TEXT_REPORT
|
||||
for line in StdOutput.getvalue().split("\n"):
|
||||
print(line)
|
||||
if ScanState == TScanState.TEXT_REPORT:
|
||||
# ignoring this part, we need json
|
||||
if line == "[":
|
||||
JsonContent += line
|
||||
ScanState = TScanState.JSON_REPORT
|
||||
elif line == "[]":
|
||||
JsonContent += line
|
||||
ScanState = TScanState.OTHER_REPORT_START
|
||||
|
||||
elif ScanState == TScanState.JSON_REPORT:
|
||||
JsonContent += line
|
||||
if line == "]":
|
||||
ScanState = TScanState.OTHER_REPORT_START
|
||||
|
||||
elif ScanState == TScanState.OTHER_REPORT_START:
|
||||
if res := re.search(r"^(\d+)(?= statements analysed.)", line):
|
||||
RES_all["NbAnalysedStatments"] = float(res.group(1))
|
||||
if line == "Statistics by type":
|
||||
ScanState = TScanState.OTHER_REPORT_STATISTICS
|
||||
|
||||
elif ScanState == TScanState.OTHER_REPORT_STATISTICS:
|
||||
if res := re.search(r"^(\d+)(?= lines have been analyzed)", line):
|
||||
RES_all["NbAnalysedLines"] = float(res.group(1))
|
||||
elif line == "Raw metrics":
|
||||
ScanState = TScanState.OTHER_REPORT_METRICS
|
||||
else:
|
||||
with suppress(PyLintMetricNotFound):
|
||||
RES_all["Statistics"]["module"] = cls.TryExtractPYReportMetric(line, "module")
|
||||
with suppress(PyLintMetricNotFound):
|
||||
RES_all["Statistics"]["class"] = cls.TryExtractPYReportMetric(line, "class")
|
||||
with suppress(PyLintMetricNotFound):
|
||||
RES_all["Statistics"]["method"] = cls.TryExtractPYReportMetric(line, "method")
|
||||
with suppress(PyLintMetricNotFound):
|
||||
RES_all["Statistics"]["function"] = cls.TryExtractPYReportMetric(line, "function")
|
||||
|
||||
elif ScanState == TScanState.OTHER_REPORT_METRICS:
|
||||
if line == "Duplication":
|
||||
RES_all["RawMetricsPercent"]["code"] = RES_all["RawMetrics"]["code"] / RES_all["NbAnalysedLines"]
|
||||
RES_all["RawMetricsPercent"]["docstring"] = RES_all["RawMetrics"]["docstring"] / RES_all["NbAnalysedLines"]
|
||||
RES_all["RawMetricsPercent"]["comment"] = RES_all["RawMetrics"]["comment"] / RES_all["NbAnalysedLines"]
|
||||
RES_all["RawMetricsPercent"]["empty"] = RES_all["RawMetrics"]["empty"] / RES_all["NbAnalysedLines"]
|
||||
ScanState = TScanState.OTHER_REPORT_DUPLICATION
|
||||
else:
|
||||
with suppress(PyLintMetricNotFound):
|
||||
RES_all["RawMetrics"]["code"] = cls.TryExtractPYReportMetric(line, "code")
|
||||
with suppress(PyLintMetricNotFound):
|
||||
RES_all["RawMetrics"]["docstring"] = cls.TryExtractPYReportMetric(line, "docstring")
|
||||
with suppress(PyLintMetricNotFound):
|
||||
RES_all["RawMetrics"]["comment"] = cls.TryExtractPYReportMetric(line, "comment")
|
||||
with suppress(PyLintMetricNotFound):
|
||||
RES_all["RawMetrics"]["empty"] = cls.TryExtractPYReportMetric(line, "empty")
|
||||
|
||||
elif ScanState == TScanState.OTHER_REPORT_DUPLICATION:
|
||||
if line == "Messages by category":
|
||||
ScanState = TScanState.OTHER_REPORT_MESSAGES_CAT
|
||||
else:
|
||||
with suppress(PyLintMetricNotFound):
|
||||
RES_all["Duplication"]["NbDupLines"] = cls.TryExtractPYReportMetric(line, "nb duplicated lines")
|
||||
with suppress(PyLintMetricNotFound):
|
||||
RES_all["Duplication"]["PersentDuplicatedLines"] = cls.TryExtractPYReportMetric(
|
||||
line, "percent duplicated lines"
|
||||
)
|
||||
|
||||
elif ScanState == TScanState.OTHER_REPORT_MESSAGES_CAT:
|
||||
if line == "Messages":
|
||||
ScanState = TScanState.OTHER_REPORT_MESSAGES
|
||||
else:
|
||||
with suppress(PyLintMetricNotFound):
|
||||
RES_all["MessagesCat"]["Convention"] = cls.TryExtractPYReportMetric(line, "convention")
|
||||
with suppress(PyLintMetricNotFound):
|
||||
RES_all["MessagesCat"]["Refactor"] = cls.TryExtractPYReportMetric(line, "refactor")
|
||||
with suppress(PyLintMetricNotFound):
|
||||
RES_all["MessagesCat"]["Warning"] = cls.TryExtractPYReportMetric(line, "warning")
|
||||
with suppress(PyLintMetricNotFound):
|
||||
RES_all["MessagesCat"]["Error"] = cls.TryExtractPYReportMetric(line, "error")
|
||||
|
||||
elif ScanState == TScanState.OTHER_REPORT_MESSAGES:
|
||||
# approx match because the number of '-' depend on screen width..
|
||||
if line.startswith("--------"):
|
||||
ScanState = TScanState.OTHER_REPORT_END
|
||||
else:
|
||||
for PylintMessage in cls.PylintMessageList.keys():
|
||||
with suppress(PyLintMetricNotFound):
|
||||
RES_all["Messages"][PylintMessage] = cls.TryExtractPYReportMetric(line, PylintMessage)
|
||||
|
||||
elif ScanState == TScanState.OTHER_REPORT_END:
|
||||
if res := re.search(r"(?<=Your code has been rated at )(\d+(?:\.\d+)?)/10", line):
|
||||
RES_all["GlobalScore"] = float(res.group(1))
|
||||
print(RES_all["GlobalScore"])
|
||||
else:
|
||||
raise RuntimeError("Invalid ScanState")
|
||||
Outfile.write(JsonContent)
|
||||
|
||||
with open(cls.get_result_dir() / "metrics.json", "w") as json_file:
|
||||
json.dump(RES_all, json_file)
|
||||
|
||||
# exporting all Data in one csv, unused atm because jenkins seems not able to select columns from csv an keep displaying all...
|
||||
# => to export a working full csv we need to a 'flat' dict (no more nested dict)
|
||||
RES_all_trim = copy.deepcopy(RES_all)
|
||||
del RES_all_trim["Messages"]
|
||||
flat_RES_all = pandas.json_normalize(RES_all_trim, sep="_").to_dict(orient="records")[0]
|
||||
|
||||
with open(cls.get_result_dir() / "metrics.csv", "w", newline="") as csv_file:
|
||||
writer = csv.DictWriter(csv_file, fieldnames=flat_RES_all.keys())
|
||||
writer.writeheader()
|
||||
writer.writerow(flat_RES_all)
|
||||
|
||||
# splited csv exports for jenkins plots: RawMetricsPercent
|
||||
RES_all_percent = RES_all["RawMetricsPercent"]
|
||||
with open(cls.get_result_dir() / "metrics_rawpercent.csv", "w", newline="") as csv_file:
|
||||
writer = csv.DictWriter(csv_file, fieldnames=RES_all_percent.keys())
|
||||
writer.writeheader()
|
||||
writer.writerow(RES_all_percent)
|
||||
|
||||
# splited csv exports for jenkins plots: Statistics + Duplication + NbAnalysedStatments + NbAnalysedLines
|
||||
RES_all_stats = copy.deepcopy(RES_all["Statistics"])
|
||||
RES_all_stats["NbDupLines"] = RES_all["Duplication"]["NbDupLines"]
|
||||
RES_all_stats["PersentDuplicatedLines"] = RES_all["Duplication"]["PersentDuplicatedLines"]
|
||||
RES_all_stats["NbAnalysedStatments"] = RES_all["NbAnalysedStatments"]
|
||||
RES_all_stats["NbAnalysedLines"] = RES_all["NbAnalysedLines"]
|
||||
with open(cls.get_result_dir() / "metrics_Statistics.csv", "w", newline="") as csv_file:
|
||||
writer = csv.DictWriter(csv_file, fieldnames=RES_all_stats.keys())
|
||||
writer.writeheader()
|
||||
writer.writerow(RES_all_stats)
|
||||
|
||||
# splited csv exports for jenkins plots: Statistics + Duplication
|
||||
RES_all_MessagesCat = RES_all["MessagesCat"]
|
||||
with open(cls.get_result_dir() / "metrics_MessagesCat.csv", "w", newline="") as csv_file:
|
||||
writer = csv.DictWriter(csv_file, fieldnames=RES_all_MessagesCat.keys())
|
||||
writer.writeheader()
|
||||
writer.writerow(RES_all_MessagesCat)
|
||||
|
||||
# splited csv exports for jenkins plots: GlobalScore
|
||||
RES_GlobalScore = {"GlobalScore": RES_all["GlobalScore"]}
|
||||
with open(cls.get_result_dir() / "metrics_GlobalScore.csv", "w", newline="") as csv_file:
|
||||
writer = csv.DictWriter(csv_file, fieldnames=RES_GlobalScore.keys())
|
||||
writer.writeheader()
|
||||
writer.writerow(RES_GlobalScore)
|
||||
|
||||
# converting the report using pylint_json2html (/!\ internal API, but as their is no leading '_' ...)
|
||||
with open(cls.get_result_dir() / "report.html", "w+", encoding="utf-8") as Outfile:
|
||||
raw_data = json.loads(JsonContent)
|
||||
report = pylint_json2html.Report(raw_data)
|
||||
Outfile.write(report.render())
|
||||
|
||||
print("Done")
|
||||
@@ -1,61 +0,0 @@
|
||||
# pyChaChaDummyProject (c) by chacha
|
||||
#
|
||||
# pyChaChaDummyProject is licensed under a
|
||||
# Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Unported License.
|
||||
#
|
||||
# You should have received a copy of the license along with this
|
||||
# work. If not, see <https://creativecommons.org/licenses/by-nc-sa/4.0/>.
|
||||
|
||||
from __future__ import annotations
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
from mypy import api
|
||||
|
||||
from .helper_base import helper_withresults_base
|
||||
|
||||
|
||||
class types_check(helper_withresults_base):
|
||||
JUnitReportName = "junit.xml"
|
||||
|
||||
@classmethod
|
||||
def do_job(cls):
|
||||
print("checking code typing ...")
|
||||
result = api.run(
|
||||
[ # project path
|
||||
"-m",
|
||||
"src." + str(cls.pyproject["project"]["name"]),
|
||||
# analysis configuration
|
||||
"--ignore-missing-imports",
|
||||
"--strict-equality",
|
||||
# reports generation
|
||||
"--cobertura-xml-report",
|
||||
str(cls.get_result_dir()),
|
||||
"--html-report",
|
||||
str(cls.get_result_dir()),
|
||||
"--linecount-report",
|
||||
str(cls.get_result_dir()),
|
||||
"--linecoverage-report",
|
||||
str(cls.get_result_dir()),
|
||||
"--lineprecision-report",
|
||||
str(cls.get_result_dir()),
|
||||
"--txt-report",
|
||||
str(cls.get_result_dir()),
|
||||
"--xml-report",
|
||||
str(cls.get_result_dir()),
|
||||
"--junit-xml",
|
||||
str(cls.get_result_dir()) + "/" + cls.JUnitReportName,
|
||||
]
|
||||
)
|
||||
|
||||
if result[0]:
|
||||
print("\nType checking report:\n")
|
||||
print(result[0]) # stdout
|
||||
|
||||
if result[1]:
|
||||
print("\nError report:\n")
|
||||
print(result[1]) # stderr
|
||||
|
||||
print("\nExit status:", result[2])
|
||||
print("Done")
|
||||
@@ -1,81 +0,0 @@
|
||||
# pyChaChaDummyProject (c) by chacha
|
||||
#
|
||||
# pyChaChaDummyProject is licensed under a
|
||||
# Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Unported License.
|
||||
#
|
||||
# You should have received a copy of the license along with this
|
||||
# work. If not, see <https://creativecommons.org/licenses/by-nc-sa/4.0/>.
|
||||
|
||||
from __future__ import annotations
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
from pathlib import Path
|
||||
import os
|
||||
import datetime
|
||||
|
||||
import unittest
|
||||
import xmlrunner
|
||||
from junitparser import JUnitXml
|
||||
from junit2htmlreport import parser as junit2html_parser
|
||||
|
||||
from .helper_base import helper_withresults_base
|
||||
|
||||
|
||||
class unit_test(helper_withresults_base):
|
||||
enable_coverage_check: bool = False
|
||||
enable_xml_export: bool = True
|
||||
enable_full_xml_export: bool = True
|
||||
FullReportName: str = "full_report"
|
||||
CoverageReportName: str = "test_coverage"
|
||||
|
||||
@classmethod
|
||||
def do_job(cls):
|
||||
if cls.enable_coverage_check == True:
|
||||
import coverage
|
||||
|
||||
# preparing unittest framework
|
||||
test_loader = unittest.TestLoader()
|
||||
|
||||
if cls.enable_coverage_check == True:
|
||||
# we start coverage now because module files discovery is part of the coverage measurement
|
||||
CoverageReportPath = Path(str(cls.get_result_dir()) + "_coverage")
|
||||
cls._reset_dir(CoverageReportPath)
|
||||
cov = coverage.Coverage(cover_pylib=False, branch=True, source_pkgs=["src." + cls.pyproject["project"]["name"]])
|
||||
cov.start()
|
||||
|
||||
package_tests = test_loader.discover(
|
||||
start_dir=str(cls.project_rootdir_path / "test"), top_level_dir=str(cls.project_rootdir_path / "test")
|
||||
)
|
||||
if cls.enable_xml_export:
|
||||
testRunner = xmlrunner.XMLTestRunner(output=str(str(cls.get_result_dir())))
|
||||
else:
|
||||
testRunner = unittest.TextTestRunner()
|
||||
|
||||
# running the test
|
||||
testRunner.run(package_tests)
|
||||
|
||||
print("Test Finished")
|
||||
if cls.enable_coverage_check == True:
|
||||
cov.stop()
|
||||
cov.save()
|
||||
cov.html_report(directory=str(CoverageReportPath))
|
||||
cov.xml_report(outfile=(CoverageReportPath / f"{cls.CoverageReportName}.xml"))
|
||||
|
||||
# computing results (Only if xml available)
|
||||
if cls.enable_full_xml_export == True:
|
||||
print("Full reports generation...")
|
||||
FullReportPath = Path(str(cls.get_result_dir()) + "_full")
|
||||
cls._reset_dir(FullReportPath)
|
||||
|
||||
FullJUnitReport = JUnitXml()
|
||||
for fname in [fname for fname in os.listdir(cls.get_result_dir()) if fname.endswith(".xml")]:
|
||||
FullJUnitReport += JUnitXml.fromfile(str(cls.get_result_dir() / fname))
|
||||
|
||||
current_datetime = datetime.datetime.utcnow().strftime("%Y%m%dT%H%M%SZ")
|
||||
full_report_base_name = f'{cls.pyproject["project"]["name"]}-{cls.FullReportName}-{current_datetime}'
|
||||
FullJUnitReport.write(str(FullReportPath / f"{full_report_base_name}.xml"))
|
||||
report = junit2html_parser.Junit(FullReportPath / f"{full_report_base_name}.xml")
|
||||
html = report.html()
|
||||
with open(FullReportPath / f"{full_report_base_name}.html", "wb") as outfile:
|
||||
outfile.write(html.encode("utf-8"))
|
||||
print("Done")
|
||||
5
helpers_proxy/__main__.py
Normal file
5
helpers_proxy/__main__.py
Normal file
@@ -0,0 +1,5 @@
|
||||
from chacha_cicd_helper.__main__ import fct_main
|
||||
import sys
|
||||
|
||||
if __name__ == "__main__":
|
||||
fct_main(sys.argv[1:])
|
||||
20
mkdocs.yml
20
mkdocs.yml
@@ -15,11 +15,11 @@ theme:
|
||||
- navigation.tabs
|
||||
- navigation.tabs.sticky
|
||||
- navigation.footer
|
||||
- toc.integrate
|
||||
- navigation.path
|
||||
- navigation.top
|
||||
- navigation.section
|
||||
- content.code.annotate
|
||||
- navigation.prune
|
||||
- navigation.expand
|
||||
- toc.follow
|
||||
palette:
|
||||
- media: '(prefers-color-scheme: dark)'
|
||||
@@ -45,26 +45,30 @@ plugins:
|
||||
default_handler: python
|
||||
handlers:
|
||||
python:
|
||||
path:
|
||||
- src
|
||||
options:
|
||||
filters:
|
||||
- '!^_[^_]'
|
||||
inherited_members: true
|
||||
inherited_members: false
|
||||
show_if_no_docstring: true
|
||||
show_signature_annotations: true
|
||||
show_source: false
|
||||
show_category_heading: true
|
||||
group_by_category: true
|
||||
docstring_section_style: spacy
|
||||
show_root_full_path: false
|
||||
merge_init_into_class: true
|
||||
separate_signature: true
|
||||
heading_level: 2
|
||||
docstring_section_style: spacy
|
||||
show_root_toc_entry: false
|
||||
- with-pdf:
|
||||
cover_subtitle: User Manual
|
||||
cover_logo: C:\Users\chacha\git\pychangelogfactory\docs-static\Library.jpg
|
||||
verbose: false
|
||||
exclude_pages:
|
||||
- LICENSE
|
||||
output_path: C:\Users\chacha\git\pychangelogfactory\helpers-results\doc_gen\site\pdf\manual.pdf
|
||||
output_path: C:\Users\chacha\git\pychangelogfactory\helpers-results\cl_doc_gen\site\pdf\manual.pdf
|
||||
markdown_extensions:
|
||||
- def_list
|
||||
- tables
|
||||
@@ -111,8 +115,8 @@ markdown_extensions:
|
||||
- footnotes
|
||||
- pymdownx.superfences
|
||||
- pymdownx.emoji:
|
||||
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||
emoji_index: !!python/name:materialx.emoji.twemoji ''
|
||||
emoji_generator: !!python/name:materialx.emoji.to_svg ''
|
||||
extra:
|
||||
branch: master
|
||||
repository: pygitversionhelper
|
||||
repository: pychangelogfactory
|
||||
|
||||
@@ -46,7 +46,21 @@ include-package-data = true
|
||||
where = ["src"]
|
||||
|
||||
[tool.setuptools.package-data]
|
||||
"pychangelogfactory.data" = ["*.*"]
|
||||
"pysimpleini" = ["py.typed"]
|
||||
|
||||
# [[tool.mypy.overrides]]
|
||||
# module = ""
|
||||
# ignore_missing_imports = true
|
||||
|
||||
[tool.coverage.run]
|
||||
cover_pylib = false
|
||||
branch = true
|
||||
data_file="helpers-results/cl_unit_test_raw_coverage/.coverage"
|
||||
# debug = ["config","multiproc","process"]
|
||||
parallel = true
|
||||
concurrency = [
|
||||
'thread'
|
||||
]
|
||||
|
||||
[project.urls]
|
||||
Homepage = "https://chacha.ddns.net/gitea/chacha/pychangelogfactory"
|
||||
@@ -54,12 +68,12 @@ Documentation = "https://chacha.ddns.net/mkdocs-web/chacha/pychangelogfactory/
|
||||
Tracker = "https://chacha.ddns.net/gitea/chacha/pychangelogfactory/issues"
|
||||
|
||||
[project.optional-dependencies]
|
||||
test = ["junitparser>=2.8","junit2html>=30.1","xmlrunner>=1.7","mypy>=0.99" ]
|
||||
coverage-check = ["coverage>=7.0"]
|
||||
complexity-check = ["radon>=5.1"]
|
||||
quality-check = ["pylint>=2.15","pylint-json2html>=0.4","pandas>=1.5"]
|
||||
type-check = ["mypy[reports]>=0.99" ]
|
||||
doc-gen = ["mkdocs>=1.4.0", "mkdocs-material>=8.5","mkdocs-pymdownx-material-extras", "mkdocs-localsearch>=0.9.0", "mkdocstrings[python]>=0.19", "mkdocs-with-pdf>=0.9.3","pyyaml>=6.0","pymdown-extensions>=9","mkdocs-markdownextradata-plugin","mkdocs-mermaid2-plugin"]
|
||||
test = ["chacha_cicd_helper"]
|
||||
coverage-check = ["chacha_cicd_helper"]
|
||||
complexity-check = ["chacha_cicd_helper"]
|
||||
quality-check = ["chacha_cicd_helper"]
|
||||
type-check = ["chacha_cicd_helper"]
|
||||
doc-gen = ["chacha_cicd_helper"]
|
||||
|
||||
#[project.scripts]
|
||||
#my-script = "my_package.module:function"
|
||||
|
||||
@@ -20,4 +20,4 @@ except PackageNotFoundError: # pragma: no cover
|
||||
warnings.warn("can not read __version__, assuming local test context, setting it to ?.?.?")
|
||||
__version__ = "?.?.?"
|
||||
|
||||
from .changelogfactory import ChangeLogFactory, ChangeLogFormaterRecordType, ChangeLogFormater
|
||||
from .changelogfactory import ChangelogFactory, ChangelogFormaterRecordType, ChangelogFormater
|
||||
|
||||
@@ -15,51 +15,119 @@
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import re
|
||||
from re import Match, search, compile as _compile, match
|
||||
from abc import ABC
|
||||
from copy import deepcopy
|
||||
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
from typing import Generic, TypeVar, cast
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from typing import Optional, ClassVar, Type, Dict, List
|
||||
|
||||
T_ChangelogFormater = TypeVar("T_ChangelogFormater", bound="ChangelogFormater")
|
||||
|
||||
|
||||
def ChangeLogFormaterRecordType(Klass: type) -> type:
|
||||
"""Decorator helper function to register interface implementation in factory
|
||||
class _ChangelogFormatersCtx(Generic[T_ChangelogFormater]):
|
||||
"""Storage class that manage Formaters"""
|
||||
|
||||
def __init__(self) -> None:
|
||||
"""Storage class init method"""
|
||||
self._savedFormaterList: set[Type[T_ChangelogFormater]] = set()
|
||||
|
||||
def add(self, record: Type[T_ChangelogFormater]) -> None:
|
||||
"""Add a Formater to the storage class
|
||||
Args:
|
||||
record: the Formater class to be added
|
||||
"""
|
||||
self._savedFormaterList.add(record)
|
||||
|
||||
def remove(self, record: Type[T_ChangelogFormater]) -> None:
|
||||
"""Remove a Formater from the storage class
|
||||
Args:
|
||||
record: the Formater class to be removed
|
||||
"""
|
||||
self._savedFormaterList.remove(record)
|
||||
|
||||
def reset(self) -> None:
|
||||
"""Reset the storage class"""
|
||||
self._savedFormaterList = set()
|
||||
|
||||
def get(self) -> set[Type[T_ChangelogFormater]]:
|
||||
"""Get the storage data set
|
||||
Returns:
|
||||
The internal storage class (set)
|
||||
"""
|
||||
return self._savedFormaterList
|
||||
|
||||
def __copy__(self) -> _ChangelogFormatersCtx[T_ChangelogFormater]:
|
||||
"""Copy the class"""
|
||||
cls = self.__class__
|
||||
result = cls.__new__(cls)
|
||||
result._savedFormaterList = self._savedFormaterList
|
||||
return result
|
||||
|
||||
def __deepcopy__(self, memo: Dict[int, object]) -> _ChangelogFormatersCtx[T_ChangelogFormater]:
|
||||
"""Deep-Copy the class
|
||||
Args:
|
||||
memo: __deepcopy__ interface impl"""
|
||||
result = self.__copy__()
|
||||
memo[id(self)] = result
|
||||
result._savedFormaterList = self._savedFormaterList.copy()
|
||||
return result
|
||||
|
||||
|
||||
def ChangelogFormaterRecordType(Klass: Type[T_ChangelogFormater]) -> Type[T_ChangelogFormater]:
|
||||
"""Decorator function that registers formater implementation in factory
|
||||
Args:
|
||||
Klass: class to register in the factory
|
||||
Returns:
|
||||
untouched class"""
|
||||
ChangeLogFactory.ar_FormaterKlass.add(Klass)
|
||||
ChangelogFactory.RegisterBaseFormater(Klass)
|
||||
return Klass
|
||||
|
||||
|
||||
class ChangeLogFormater(ABC):
|
||||
|
||||
prefix: str = "^\s+"
|
||||
title: str = "Others :"
|
||||
keywords: list[str] = []
|
||||
priority: int = 0
|
||||
|
||||
_lines: list[str] = []
|
||||
|
||||
def __init__(self):
|
||||
"""ChangeLogFormater class constructor
|
||||
|
||||
This class is the base formater class.
|
||||
|
||||
This class is for:
|
||||
|
||||
- classifying message: CheckLine() and CheckLine_keywords()
|
||||
- storing lines: Clear() and PushLine()
|
||||
- returning the formated output: Render() and RenderLines()
|
||||
def _ChangelogFormaterRecordType(Klass: Type[T_ChangelogFormater]) -> Type[T_ChangelogFormater]:
|
||||
"""Internal decorator function that registers formater implementation in factory
|
||||
Args:
|
||||
Klass: class to register in the factory
|
||||
Returns:
|
||||
untouched class"""
|
||||
cast(ChangelogFactory[ChangelogFormater], ChangelogFactory).ar_SavedFormaterKlass.add(Klass)
|
||||
return ChangelogFormaterRecordType(Klass)
|
||||
|
||||
|
||||
/// warning
|
||||
this class does not aim to be instantiated by user.
|
||||
///
|
||||
class ChangelogFormater(ABC):
|
||||
"""ChangelogFormater class
|
||||
|
||||
"""
|
||||
self._lines: list[str] = []
|
||||
This class is the formater base class.
|
||||
|
||||
This class is for:
|
||||
|
||||
- classifying message: CheckLine() and CheckLine_keywords()
|
||||
- storing lines: Clear() and PushLine()
|
||||
- returning the formated output: Render() and RenderLines()
|
||||
|
||||
|
||||
/// warning
|
||||
this class does not aim to be instantiated by user.
|
||||
///
|
||||
"""
|
||||
|
||||
prefix: ClassVar[Optional[str]] = None
|
||||
title: ClassVar[Optional[str]] = None
|
||||
keywords: ClassVar[Optional[list[str]]] = None
|
||||
priority: ClassVar[int] = 0
|
||||
_lines: List[None | str] = []
|
||||
|
||||
def __init__(self) -> None:
|
||||
"""ChangelogFormater class constructor"""
|
||||
self._lines: List[None | str] = []
|
||||
|
||||
def Clear(self) -> None:
|
||||
"""Clear the formater content"""
|
||||
self._lines: list[str] = []
|
||||
self._lines = []
|
||||
|
||||
def PushLine(self, ChangelogString: str) -> None:
|
||||
"""Push a new line in the formater
|
||||
@@ -91,7 +159,7 @@ class ChangeLogFormater(ABC):
|
||||
return full_lines
|
||||
|
||||
@classmethod
|
||||
def CheckLine(cls, content: str) -> re.Match:
|
||||
def CheckLine(cls, content: str) -> None | Match[str]:
|
||||
"""Check if a line match the current formater (lazy identification)
|
||||
|
||||
/// warning
|
||||
@@ -104,7 +172,7 @@ class ChangeLogFormater(ABC):
|
||||
Returns:
|
||||
match object
|
||||
"""
|
||||
regex = re.compile(r"^(?:-\s+)?(?:{0})(?:\((.*)\))?(?::)(?:\s*)([^\s].+)".format(cls.prefix))
|
||||
regex = _compile(rf"^(?:-\s+)?(?:{cls.prefix})(?:\((.*)\))?(?::)(?:\s*)([^\s].+)")
|
||||
_match = regex.match(content)
|
||||
return _match
|
||||
|
||||
@@ -120,59 +188,95 @@ class ChangeLogFormater(ABC):
|
||||
True if a keyword has matched, False otherwise
|
||||
"""
|
||||
keyword_list = cls.keywords
|
||||
for _keyword in keyword_list:
|
||||
if (_keyword != "") and re.search(_keyword, content):
|
||||
return True
|
||||
if keyword_list:
|
||||
for _keyword in keyword_list:
|
||||
if _keyword and search(_keyword, content):
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
class ChangeLogFactory:
|
||||
class ChangelogFactory(Generic[T_ChangelogFormater]):
|
||||
"""The main changelog class"""
|
||||
|
||||
ar_FormaterKlass: set[type[ChangeLogFormater]] = set()
|
||||
ar_Formater: dict[ChangeLogFormater] = dict()
|
||||
ar_SavedFormaterKlass: ClassVar[_ChangelogFormatersCtx[ChangelogFormater]] = _ChangelogFormatersCtx[ChangelogFormater]()
|
||||
ar_FormaterKlass: _ChangelogFormatersCtx[T_ChangelogFormater] = _ChangelogFormatersCtx[T_ChangelogFormater]()
|
||||
|
||||
ar_Formater: Dict[str, T_ChangelogFormater] = {}
|
||||
checkCommentPattern: str = r"^[ \t]*(?:\/\/|#)"
|
||||
|
||||
def __init__(self, ChangelogString: None | str = None):
|
||||
"""Main ChangeLogFormater class constructor
|
||||
def __init__(self, ChangelogString: Optional[str] = None) -> None:
|
||||
"""Main ChangelogFormater class constructor
|
||||
|
||||
Args:
|
||||
ChangelogString: optionnal input string to start with
|
||||
ChangelogString: optional input string to be processed
|
||||
"""
|
||||
for FormaterKlass in ChangeLogFactory.ar_FormaterKlass:
|
||||
self.ar_Formater: Dict[str, T_ChangelogFormater] = {}
|
||||
self.ar_FormaterKlass = deepcopy(type(self).ar_FormaterKlass)
|
||||
|
||||
for FormaterKlass in self.ar_FormaterKlass.get():
|
||||
self.ar_Formater[FormaterKlass.__name__] = FormaterKlass()
|
||||
|
||||
# missing mypy coverage here because of internal bad isinstance() handling
|
||||
# could be fixed using 'type(ChangelogString) is str' but then quality check will bad
|
||||
# so let quality advise
|
||||
if isinstance(ChangelogString, str):
|
||||
self.ProcessFullChangelog(ChangelogString)
|
||||
|
||||
def RegisterFormater(self, FormaterKlass: ChangeLogFormater) -> None:
|
||||
"""Register a new formater
|
||||
def ResetFormaterList(self) -> ChangelogFactory[T_ChangelogFormater]:
|
||||
"""Reset the formater class list to original (Instance wise)
|
||||
Returns:
|
||||
self for convenience
|
||||
"""
|
||||
self.ar_FormaterKlass: T_ChangelogFormater = deepcopy(
|
||||
cast(_ChangelogFormatersCtx[T_ChangelogFormater], ChangelogFactory.ar_SavedFormaterKlass)
|
||||
)
|
||||
self.ar_Formater = {}
|
||||
for FormaterKlass in self.ar_FormaterKlass.get():
|
||||
self.ar_Formater[FormaterKlass.__name__] = FormaterKlass()
|
||||
return self
|
||||
|
||||
@classmethod
|
||||
def RegisterBaseFormater(cls, FormaterKlass: Type[T_ChangelogFormater]) -> None:
|
||||
"""Register a new formater in the current instance
|
||||
|
||||
Args:
|
||||
FormaterKlass: class of the formater to be added
|
||||
"""
|
||||
cls.ar_FormaterKlass.add(FormaterKlass)
|
||||
|
||||
@classmethod
|
||||
def ResetBaseFormaterList(cls) -> None:
|
||||
"""Reset the formater class list to original (BaseClass wise)"""
|
||||
cls.ar_FormaterKlass = deepcopy(cls.ar_SavedFormaterKlass)
|
||||
|
||||
def RegisterFormater(self, FormaterKlass: Type[T_ChangelogFormater]) -> ChangelogFactory[T_ChangelogFormater]:
|
||||
"""Register a new formater in the current instance
|
||||
|
||||
Args:
|
||||
FormaterKlass: class of the formater to be added
|
||||
Returns:
|
||||
self class for convenience
|
||||
self for convenience
|
||||
"""
|
||||
self.ar_FormaterKlass.add(FormaterKlass)
|
||||
self.ar_Formater[FormaterKlass.__name__] = FormaterKlass()
|
||||
return self
|
||||
|
||||
def unRegisterFormater(self, FormaterKlass: ChangeLogFormater) -> None:
|
||||
"""Register a new formater
|
||||
def unRegisterFormater(self, FormaterKlass: Type[T_ChangelogFormater]) -> ChangelogFactory[T_ChangelogFormater]:
|
||||
"""unRegister a new formater in the current instance
|
||||
|
||||
Args:
|
||||
FormaterKlass: class of the formater to be removed
|
||||
FormaterKlass: class of the formater to be dropped
|
||||
Returns:
|
||||
self class for convenience
|
||||
self for convenience
|
||||
"""
|
||||
self.ar_FormaterKlass.remove(FormaterKlass)
|
||||
del self.ar_Formater[FormaterKlass.__name__]
|
||||
return self
|
||||
|
||||
def Clear(self) -> ChangeLogFactory:
|
||||
def Clear(self) -> ChangelogFactory[T_ChangelogFormater]:
|
||||
"""Clear internal memory
|
||||
Returns:
|
||||
self class for convenience
|
||||
self for convenience
|
||||
"""
|
||||
for formater in self.ar_Formater.values():
|
||||
formater.Clear()
|
||||
@@ -185,14 +289,16 @@ class ChangeLogFactory:
|
||||
If a matching formater is found, line is inserted.
|
||||
|
||||
Args:
|
||||
RawChangelogLine: line to parse
|
||||
RawChangelogLine: line to process
|
||||
Returns:
|
||||
True if successfully matched, False otherwise
|
||||
"""
|
||||
for formater in sorted(self.ar_Formater.values(), key=lambda x: x.priority):
|
||||
content = formater.CheckLine(RawChangelogLine)
|
||||
if content is not None:
|
||||
formater.PushLine(content.group(2))
|
||||
content: Optional[Match[str]] = formater.CheckLine(RawChangelogLine)
|
||||
# missing mypy coverage here because of internal bad isinstance() handling AND Match type
|
||||
if isinstance(content, Match) and (len(content.groups()) == 2):
|
||||
res: str = content.group(2)
|
||||
formater.PushLine(res)
|
||||
return True
|
||||
|
||||
return False
|
||||
@@ -204,7 +310,7 @@ class ChangeLogFactory:
|
||||
If a matching formater is found, line is inserted.
|
||||
|
||||
Args:
|
||||
RawChangelogLine: line to parse
|
||||
RawChangelogLine: line to process
|
||||
Returns:
|
||||
True if successfully matched, False otherwise
|
||||
"""
|
||||
@@ -213,34 +319,37 @@ class ChangeLogFactory:
|
||||
formater.PushLine(RawChangelogLine)
|
||||
return True
|
||||
|
||||
self.ar_Formater[ChangeLogFormater_others.__name__].PushLine(RawChangelogLine)
|
||||
self.ar_Formater[ChangelogFormater_others.__name__].PushLine(RawChangelogLine)
|
||||
return False
|
||||
|
||||
def ProcessFullChangelog(self, RawChangelogMessage: str) -> ChangeLogFactory:
|
||||
def ProcessFullChangelog(self, RawChangelogMessage: str) -> ChangelogFactory[T_ChangelogFormater]:
|
||||
"""Process all input lines
|
||||
|
||||
This function handles the main 2-round changes search algo.
|
||||
It takes care of search-order and automatically skip any non-relevants message line.
|
||||
A non relevant line can be a commented one, or a to short one.
|
||||
Available comment patterns are: // and #
|
||||
|
||||
Available comment patterns are: `// and #`
|
||||
|
||||
A relevant commit line must contain:
|
||||
|
||||
- at least 2 words for formal
|
||||
- at least 3 words for keywords
|
||||
|
||||
Args:
|
||||
RawChangelogMessage: The full raw changelog (merged commit-history)
|
||||
RawChangelogMessage: The full raw changelog to be processed
|
||||
Returns:
|
||||
self class for convenience
|
||||
self for convenience
|
||||
"""
|
||||
|
||||
Lines2ndRound = []
|
||||
|
||||
for line in RawChangelogMessage.split("\n"):
|
||||
lineWordsCount = len(line.split())
|
||||
if (lineWordsCount > 1) and (not re.match(self.checkCommentPattern, line)):
|
||||
if (lineWordsCount > 1) and (not match(self.checkCommentPattern, line)):
|
||||
if self._ProcessLineMain(line) is True:
|
||||
continue
|
||||
elif lineWordsCount > 2:
|
||||
if lineWordsCount > 2:
|
||||
Lines2ndRound.append(line)
|
||||
|
||||
for line in Lines2ndRound:
|
||||
@@ -257,7 +366,8 @@ class ChangeLogFactory:
|
||||
"""
|
||||
full_changelog = ""
|
||||
for formater in sorted(self.ar_Formater.values(), key=lambda x: x.priority, reverse=True):
|
||||
if (include_unknown is False) and (isinstance(formater, ChangeLogFormater_others)):
|
||||
# missing mypy coverage here because of internal bad isinstance() handling
|
||||
if (include_unknown is False) and (isinstance(formater, ChangelogFormater_others)):
|
||||
continue
|
||||
full_changelog = full_changelog + formater.Render()
|
||||
|
||||
@@ -294,32 +404,34 @@ for RecordType, Config in {
|
||||
),
|
||||
"wip": ( 0, ["temp", ],
|
||||
"Work in progress changes :construction: :",
|
||||
),
|
||||
"doc": ( 0, [ "doc", "manual"],
|
||||
),
|
||||
"doc": ( 0, [ "doc", "manual"],
|
||||
"Documentations :book: :",
|
||||
),
|
||||
"style": ( 5, ["beautify", ],
|
||||
"Style :art: :",
|
||||
"Style :art: :",
|
||||
),
|
||||
"refactor": ( 0, [],
|
||||
"Refactorings :recycle: :"
|
||||
),
|
||||
"ci": ( 0, ["jenkins", "git"],
|
||||
"ci": ( 0, ["jenkins", "git"],
|
||||
"Continuous Integration :cyclone: :"
|
||||
),
|
||||
"test": ( -5, ["unittest", "check", "testing"],
|
||||
"test": ( -5, ["unittest", "check", "testing"],
|
||||
"Testings :vertical_traffic_light: :"
|
||||
),
|
||||
"build": ( 0, ["compile", "version"],
|
||||
"build": ( 0, ["compile", "version"],
|
||||
"Builds :package: :"
|
||||
),
|
||||
# fmt: on
|
||||
}.items():
|
||||
# then we instantiate all of them
|
||||
_name = f"ChangeLogFormater_{RecordType}"
|
||||
_tmp = globals()[_name] = type(
|
||||
_name = f"ChangelogFormater_{RecordType}"
|
||||
|
||||
# can not change globals definition so mypy will keep complaining
|
||||
_tmp = type(
|
||||
_name,
|
||||
(ChangeLogFormater,),
|
||||
(ChangelogFormater,),
|
||||
{
|
||||
"prefix": RecordType,
|
||||
"title": Config[2],
|
||||
@@ -327,17 +439,19 @@ for RecordType, Config in {
|
||||
"priority": Config[0],
|
||||
},
|
||||
)
|
||||
ChangeLogFactory.ar_FormaterKlass.add(_tmp)
|
||||
globals()[_name] = _tmp
|
||||
cast(ChangelogFactory[ChangelogFormater], ChangelogFactory).RegisterBaseFormater(_tmp)
|
||||
cast(ChangelogFactory[ChangelogFormater], ChangelogFactory).ar_SavedFormaterKlass.add(_tmp)
|
||||
|
||||
|
||||
@ChangeLogFormaterRecordType
|
||||
class ChangeLogFormater_revert(ChangeLogFormater):
|
||||
@_ChangelogFormaterRecordType
|
||||
class ChangelogFormater_revert(ChangelogFormater):
|
||||
"""Revert scope formater"""
|
||||
|
||||
prefix: str = "revert"
|
||||
title: str = "Reverts :back: :"
|
||||
keywords: list[str] = ["revert", "fallback"]
|
||||
priority: int = 0
|
||||
prefix: ClassVar[Optional[str]] = "revert"
|
||||
title: ClassVar[Optional[str]] = "Reverts :back: :"
|
||||
keywords: ClassVar[Optional[List[str]]] = ["revert", "fallback"]
|
||||
priority: ClassVar[int] = 0
|
||||
|
||||
def RenderLines(self) -> str:
|
||||
"""Render all lines
|
||||
@@ -350,11 +464,11 @@ class ChangeLogFormater_revert(ChangeLogFormater):
|
||||
return full_lines
|
||||
|
||||
|
||||
@ChangeLogFormaterRecordType
|
||||
class ChangeLogFormater_others(ChangeLogFormater):
|
||||
@_ChangelogFormaterRecordType
|
||||
class ChangelogFormater_others(ChangelogFormater):
|
||||
"""Others / unknown scope formater"""
|
||||
|
||||
prefix: str = "other"
|
||||
title: str = "Others :question: :"
|
||||
keywords: list[str] = [""]
|
||||
priority: int = -20
|
||||
prefix: ClassVar[Optional[str]] = "other"
|
||||
title: ClassVar[Optional[str]] = "Others :question: :"
|
||||
keywords: ClassVar[Optional[List[str]]] = [""]
|
||||
priority: ClassVar[int] = -20
|
||||
|
||||
1
src/pychangelogfactory/py.typed
Normal file
1
src/pychangelogfactory/py.typed
Normal file
@@ -0,0 +1 @@
|
||||
# PlaceHolder
|
||||
@@ -8,21 +8,24 @@
|
||||
|
||||
import unittest
|
||||
|
||||
from src import pychangelogfactory
|
||||
from src.pychangelogfactory import ChangelogFormater, ChangelogFactory, ChangelogFormaterRecordType
|
||||
|
||||
|
||||
class Testtest_module(unittest.TestCase):
|
||||
def simplegeneration(self, inputstr, teststrs: list[str]):
|
||||
hdlr = pychangelogfactory.ChangeLogFactory()
|
||||
def setUp(self):
|
||||
ChangelogFactory.ResetBaseFormaterList()
|
||||
|
||||
def simplegeneration(self, inputstr, teststrs: list[str], withunknown: bool = False):
|
||||
hdlr = ChangelogFactory()
|
||||
hdlr.ProcessFullChangelog(inputstr)
|
||||
changelog = hdlr.RenderFullChangelog()
|
||||
changelog = hdlr.RenderFullChangelog(include_unknown=withunknown)
|
||||
for test in teststrs:
|
||||
self.assertIn(test, changelog)
|
||||
|
||||
def test_simplegeneration_ignored2(self):
|
||||
raw = "break: testbreak break" + "\n" + "#doc: testdoc doc" + "\n" + "#style: teststyle beautify" + "\n" + "//test: testtest check"
|
||||
|
||||
hdlr = pychangelogfactory.ChangeLogFactory(raw)
|
||||
hdlr = ChangelogFactory(raw)
|
||||
changelog = hdlr.RenderFullChangelog()
|
||||
|
||||
self.assertIn("testbreak", changelog)
|
||||
@@ -33,7 +36,7 @@ class Testtest_module(unittest.TestCase):
|
||||
def test_simplegeneration_ignored(self):
|
||||
raw = "break: testbreak" + "\n" + "#doc: testdoc" + "\n" + "#style: teststyle" + "\n" + "//test: testtest"
|
||||
|
||||
hdlr = pychangelogfactory.ChangeLogFactory(raw)
|
||||
hdlr = ChangelogFactory(raw)
|
||||
changelog = hdlr.RenderFullChangelog()
|
||||
self.assertIn("testbreak", changelog)
|
||||
self.assertNotIn("testdoc", changelog)
|
||||
@@ -42,13 +45,22 @@ class Testtest_module(unittest.TestCase):
|
||||
|
||||
def test_simplegeneration_order(self):
|
||||
raw = "break: testbreak" + "\n" + "doc: testdoc" + "\n" + "style: teststyle" + "\n" + "test: testtest"
|
||||
hdlr = pychangelogfactory.ChangeLogFactory(raw)
|
||||
hdlr = ChangelogFactory(raw)
|
||||
changelog = hdlr.RenderFullChangelog().splitlines()
|
||||
self.assertIn("testbreak", changelog[1])
|
||||
self.assertIn("teststyle", changelog[3])
|
||||
self.assertIn("testdoc", changelog[5])
|
||||
self.assertIn("testtest", changelog[7])
|
||||
|
||||
def test_simplegeneration_toosmall(self):
|
||||
self.simplegeneration("one", [], True)
|
||||
self.simplegeneration("one two", [], True)
|
||||
self.simplegeneration("one two three", ["one two three"], True)
|
||||
|
||||
def test_simplegeneration_unknown(self):
|
||||
self.simplegeneration("one two three", ["one two three"], True)
|
||||
self.simplegeneration("one two three", [""], False)
|
||||
|
||||
def test_simplegeneration_multiple(self):
|
||||
raw = "break: testbreak" + "\n" + "doc: testdoc" + "\n" + "style: teststyle"
|
||||
self.simplegeneration(raw, ["testbreak", "testdoc", "teststyle"])
|
||||
@@ -144,29 +156,41 @@ class Testtest_module(unittest.TestCase):
|
||||
# fmt: on
|
||||
|
||||
def test_sample(self):
|
||||
hdlr = pychangelogfactory.ChangeLogFactory(self.raw_changelog)
|
||||
hdlr = ChangelogFactory(self.raw_changelog)
|
||||
changelog = hdlr.RenderFullChangelog(include_unknown=True)
|
||||
self.assertEqual(changelog, self.expected_formated)
|
||||
|
||||
def test_sample_aio(self):
|
||||
changelog = pychangelogfactory.ChangeLogFactory(self.raw_changelog).RenderFullChangelog(include_unknown=True)
|
||||
print(changelog)
|
||||
changelog = ChangelogFactory(self.raw_changelog).RenderFullChangelog(include_unknown=True)
|
||||
self.assertEqual(changelog, self.expected_formated)
|
||||
|
||||
def test_sample_exploded(self):
|
||||
hdlr = pychangelogfactory.ChangeLogFactory()
|
||||
hdlr = ChangelogFactory()
|
||||
hdlr.ProcessFullChangelog(self.raw_changelog)
|
||||
changelog = hdlr.RenderFullChangelog(include_unknown=True)
|
||||
self.assertEqual(changelog, self.expected_formated)
|
||||
|
||||
def test_sample_clear(self):
|
||||
hdlr = ChangelogFactory()
|
||||
hdlr.ProcessFullChangelog(self.raw_changelog)
|
||||
changelog = hdlr.RenderFullChangelog(include_unknown=True)
|
||||
self.assertEqual(changelog, self.expected_formated)
|
||||
hdlr.Clear()
|
||||
changelog = hdlr.RenderFullChangelog(include_unknown=True)
|
||||
self.assertEqual(changelog, "")
|
||||
|
||||
|
||||
class Testtest_module_othercontext(unittest.TestCase):
|
||||
def setUp(self):
|
||||
ChangelogFactory.ResetBaseFormaterList()
|
||||
|
||||
def test_custom(self):
|
||||
"""
|
||||
1st PART: register a global custom formater
|
||||
"""
|
||||
|
||||
from src.pychangelogfactory import ChangeLogFormater, ChangeLogFormaterRecordType, ChangeLogFactory
|
||||
|
||||
@ChangeLogFormaterRecordType
|
||||
class ChangeLogFormater_TEST(ChangeLogFormater):
|
||||
@ChangelogFormaterRecordType
|
||||
class ChangelogFormater_TEST(ChangelogFormater):
|
||||
"""My formater"""
|
||||
|
||||
prefix: str = "mytag"
|
||||
@@ -179,7 +203,7 @@ class Testtest_module_othercontext(unittest.TestCase):
|
||||
"foo modification in my file\n"
|
||||
"need 42 coffee\n"
|
||||
)
|
||||
expected_formated = (
|
||||
expected_formated_orig = (
|
||||
"#### My Title :\n"
|
||||
"> add a nice feature to the project\n"
|
||||
"> foo modification in my file\n"
|
||||
@@ -187,6 +211,115 @@ class Testtest_module_othercontext(unittest.TestCase):
|
||||
)
|
||||
# fmt: on
|
||||
|
||||
hdlr = ChangeLogFactory(raw_changelog)
|
||||
hdlr = ChangelogFactory(raw_changelog)
|
||||
changelog = hdlr.RenderFullChangelog(include_unknown=True)
|
||||
self.assertEqual(changelog, expected_formated_orig)
|
||||
|
||||
"""
|
||||
2nd PART: cheking the custom formater is still here after new object creation
|
||||
"""
|
||||
|
||||
hdlr = ChangelogFactory(raw_changelog)
|
||||
changelog = hdlr.RenderFullChangelog(include_unknown=True)
|
||||
self.assertEqual(changelog, expected_formated_orig)
|
||||
|
||||
"""
|
||||
3rd PART: removing the custom formater at runtime
|
||||
"""
|
||||
|
||||
hdlr = ChangelogFactory()
|
||||
hdlr.unRegisterFormater(ChangelogFormater_TEST)
|
||||
hdlr.ProcessFullChangelog(raw_changelog)
|
||||
changelog = hdlr.RenderFullChangelog(include_unknown=True)
|
||||
|
||||
# fmt: off
|
||||
expected_formated = (
|
||||
"#### Features :sparkles: :\n"
|
||||
"> mytag: add a nice feature to the project\n"
|
||||
"#### Others :question: :\n"
|
||||
"> foo modification in my file\n"
|
||||
"> need 42 coffee\n"
|
||||
)
|
||||
# fmt: on
|
||||
|
||||
self.assertEqual(changelog, expected_formated)
|
||||
|
||||
"""
|
||||
4th PART: checking it is back when create new obj
|
||||
"""
|
||||
|
||||
hdlr = ChangelogFactory()
|
||||
hdlr.ProcessFullChangelog(raw_changelog)
|
||||
changelog = hdlr.RenderFullChangelog(include_unknown=True)
|
||||
self.assertEqual(changelog, expected_formated_orig)
|
||||
|
||||
"""
|
||||
3.1rd PART: removing the custom formater at runtime
|
||||
"""
|
||||
|
||||
hdlr = ChangelogFactory()
|
||||
hdlr.ResetFormaterList()
|
||||
hdlr.ProcessFullChangelog(raw_changelog)
|
||||
changelog = hdlr.RenderFullChangelog(include_unknown=True)
|
||||
self.assertEqual(changelog, expected_formated)
|
||||
|
||||
"""
|
||||
4.1th PART: checking it is back when create new obj
|
||||
"""
|
||||
|
||||
hdlr = ChangelogFactory()
|
||||
hdlr.ProcessFullChangelog(raw_changelog)
|
||||
changelog = hdlr.RenderFullChangelog(include_unknown=True)
|
||||
self.assertEqual(changelog, expected_formated_orig)
|
||||
|
||||
"""
|
||||
5th PART: reseting class list globally
|
||||
"""
|
||||
ChangelogFactory.ResetBaseFormaterList()
|
||||
hdlr = ChangelogFactory()
|
||||
hdlr.ProcessFullChangelog(raw_changelog)
|
||||
changelog = hdlr.RenderFullChangelog(include_unknown=True)
|
||||
self.assertEqual(changelog, expected_formated)
|
||||
|
||||
"""
|
||||
6th PART: checking it is still not here
|
||||
"""
|
||||
hdlr = ChangelogFactory()
|
||||
hdlr.ProcessFullChangelog(raw_changelog)
|
||||
changelog = hdlr.RenderFullChangelog(include_unknown=True)
|
||||
self.assertEqual(changelog, expected_formated)
|
||||
|
||||
|
||||
class Testtest_module_othercontext2(unittest.TestCase):
|
||||
def setUp(self):
|
||||
ChangelogFactory.ResetBaseFormaterList()
|
||||
|
||||
def test_custom2(self):
|
||||
class ChangelogFormater_TEST2(ChangelogFormater):
|
||||
"""My formater"""
|
||||
|
||||
prefix: str = "mytag"
|
||||
title: str = "My Title 2:"
|
||||
keywords: list[str] = ["foo", "42"]
|
||||
priority: int = 10
|
||||
|
||||
# fmt: off
|
||||
raw_changelog = ("mytag: add a nice feature to the project\n"
|
||||
"foo modification in my file\n"
|
||||
"need 42 coffee\n"
|
||||
)
|
||||
expected_formated = (
|
||||
"#### My Title 2:\n"
|
||||
"> add a nice feature to the project\n"
|
||||
"> foo modification in my file\n"
|
||||
"> need 42 coffee\n"
|
||||
)
|
||||
# fmt: on
|
||||
|
||||
hdlr = ChangelogFactory()
|
||||
|
||||
hdlr.RegisterFormater(ChangelogFormater_TEST2)
|
||||
|
||||
hdlr.ProcessFullChangelog(raw_changelog)
|
||||
changelog = hdlr.RenderFullChangelog(include_unknown=True)
|
||||
self.assertEqual(changelog, expected_formated)
|
||||
|
||||
Reference in New Issue
Block a user