Skip to content

Commit

Permalink
Apply rebranding (#1) (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinGroscheTT authored Jan 17, 2024
1 parent c1cb0d0 commit a071867
Show file tree
Hide file tree
Showing 54 changed files with 91 additions and 105 deletions.
2 changes: 1 addition & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2022-2023 TraceTronic GmbH
# Copyright (c) 2022-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/1-feature-request.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Copyright (C) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

name: '💡 Feature Request'
description: 'Feature request template for TEST-GUIDE Json Generator development'
description: 'Feature request template for test.guide Json Generator development'
labels: ['feature']

body:
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/2-bug-report.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (C) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand Down Expand Up @@ -46,5 +46,5 @@ body:
attributes:
value: |
**Never report security issues on GitHub or other public channels (Gitter/Twitter/etc.).**
Instead, use our [TraceTronic Support Center](https://support.tracetronic.com). For reporting issues
containing NDA relevant information please also use our [TraceTronic Support Center](https://support.tracetronic.com).
Instead, use our [tracetronic Support Center](https://support.tracetronic.com). For reporting issues
containing NDA relevant information please also use our [tracetronic Support Center](https://support.tracetronic.com).
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Copyright (C) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

blank_issues_enabled: false
contact_links:
- name: TraceTronic Support Center
- name: tracetronic Support Center
url: https://support.tracetronic.com
about: Please report security vulnerabilities and non-public issues (i.e. NDA relevant information) here.
2 changes: 1 addition & 1 deletion .github/automation_scripts/scripts.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand Down
4 changes: 2 additions & 2 deletions .github/labels.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (C) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand Down Expand Up @@ -30,7 +30,7 @@
description: Security related issue
color: 7f0e6f
- name: test-guide
description: TEST-GUIDE related issue
description: test.guide related issue
color: 208ca3
- name: test
description: Testing
Expand Down
2 changes: 1 addition & 1 deletion .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (C) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/auto-merge-actions-updates.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (C) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/close-fork-prs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (C) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/dependency-check.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (C) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (C) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/md-link-checker.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (C) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (C) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (C) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/reuse.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (C) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/sync-labels.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (C) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (C) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/update-gh-pages.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (C) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand Down
6 changes: 3 additions & 3 deletions .reuse/dep5
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: TraceTronic TEST-GUIDE JSON Generator for Python
Upstream-Contact: TraceTronic GmbH <[email protected]>
Upstream-Name: tracetronic test.guide JSON Generator for Python
Upstream-Contact: tracetronic GmbH <[email protected]>
Source: https://github.com/tracetronic/testguide_report-generator

Files: **/*.json Pipfile* .gitignore **/artifact* **/*.png
Copyright: 2023 TraceTronic GmbH <[email protected]>
Copyright: 2023-2024 tracetronic GmbH <[email protected]>
License: MIT
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2022-2023 TraceTronic GmbH
Copyright (c) 2022-2024 tracetronic GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion LICENSES/MIT.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 TraceTronic GmbH
Copyright (c) 2023-2024 tracetronic GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
44 changes: 15 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,36 @@
<!--
Copyright (c) 2022-2023 TraceTronic GmbH
Copyright (c) 2022-2024 tracetronic GmbH
SPDX-License-Identifier: MIT
-->

# TEST-GUIDE Report Generator
# test.guide Report Generator


<!-- markdown-link-check-disable -->
[![Testing](https://github.com/tracetronic/testguide_json_generator_python/actions/workflows/test.yml/badge.svg)](https://github.com/tracetronic/testguide_json_generator_python/actions/workflows/test.yml) [![Releases](https://img.shields.io/badge/Releases-Changelog-blue)](https://github.com/tracetronic/testguide_json_generator_python/releases) [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/tracetronic/testguide_json_generator_python/blob/main/LICENSE)
<!-- markdown-link-check-enable -->
[![Test](https://github.com/tracetronic/testguide_report-generator/actions/workflows/test.yml/badge.svg)](https://github.com/tracetronic/testguide_report-generator/actions/workflows/test.yml) [![Releases](https://img.shields.io/badge/Releases-Changelog-blue)](https://github.com/tracetronic/testguide_report-generator/releases) [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/tracetronic/testguide_report-generator/blob/main/LICENSE)

As a modern automotive test engineer, reliance on automated solutions for the execution, reporting and evaluation of my test suites is essential.
The complexity of the systems under test, and thus the amount of necessary tests is ever growing tremendously. One of the tools which can help
with these tasks is [TraceTronic TEST-GUIDE](https://www.tracetronic.com/products/test-guide/). As a user of TEST-GUIDE, it is desirable to have
with these tasks is [tracetronic test.guide](https://www.tracetronic.com/products/test-guide/). As a user of test.guide, it is desirable to have
a means to customize and structure my test reports in a simple manner.

This generator acts as a helper to create a [TEST-GUIDE](https://www.tracetronic.com/products/test-guide/) compatible
This generator acts as a helper to create a [test.guide](https://www.tracetronic.com/products/test-guide/) compatible
test report. Specific Python classes reflecting the different elements of a test report (*TestSuite*, *TestCase* and so on)
were designed in such a way that you can create your own testsuite from these objects. This facilitates the conversion from arbitrary test report
formats into a *.json* which TEST-GUIDE can handle. With this generator, it is no more necessary to convert non-ATX formats directly
into a *.json* for TEST-GUIDE. Instead, the delivered Python classes are prefilled in a simple manner, and the *.json* is
formats into a *.json* which test.guide can handle. With this generator, it is no more necessary to convert non-ATX formats directly
into a *.json* for test.guide. Instead, the delivered Python classes are prefilled in a simple manner, and the *.json* is
generated for you. On top of this, early format checks are conducted such that you will be notified right away if something is not
compliant to the *json* schema.

<!-- markdown-link-check-disable -->
<img src="https://github.com/tracetronic/testguide_json_generator_python/blob/main/docs/images/Logo_TEST-GUIDE_rgb_SCREEN.png?raw=true" align="left" alt="TEST-GUIDE" width="300">
<!-- markdown-link-check-enable-->
<img src="https://github.com/tracetronic/testguide_report-generator/blob/main/docs/images/Logo_TEST-GUIDE_rgb_SCREEN.png?raw=true" align="left" alt="test.guide" width="300">

TEST-GUIDE is a database application for the overview, analysis and follow-up processing of test procedures, which has been specially
test.guide is a database application for the overview, analysis and follow-up processing of test procedures, which has been specially
developed for use in the automotive sector. It significantly facilitates the management of test resources. At the same time, it encourages
cross-role cooperation, thereby closing the gap between test execution and test management.
<br />

<!-- markdown-link-check-disable -->
<img src="https://github.com/tracetronic/testguide_json_generator_python/blob/main/docs/images/platform_logo.png?raw=true" align="right" alt="Automotive DevOps Platform">
<!-- markdown-link-check-enable-->

<br />

**TraceTronic TEST-GUIDE Report Generator** project is part of
the [Automotive DevOps Platform](https://www.tracetronic.com/products/automotive-devops-platform/) by TraceTronic. With
**tracetronic test.guide Report Generator** project is part of
the [Automotive DevOps Platform](https://www.tracetronic.com/products/automotive-devops-platform/) by tracetronic. With
the **Automotive DevOps Platform**, we go from the big picture to the details and unite all phases of vehicle software
testing – from planning the test scopes to summarizing the test results. At the same time, continuous monitoring across
all test phases always provides an overview of all activities – even with several thousand test executions per day and
Expand Down Expand Up @@ -71,9 +61,7 @@ or by adding the _testguide-report-generator_ to your dependency management file

## Getting Started

<!-- markdown-link-check-disable -->
The commands which are necessary to generate [TEST-GUIDE](https://www.tracetronic.com/products/test-guide/) reports are collected exemplarily in the [*example_TestSuite.py*](/example_TestSuite.py). Run the example script to generate *json* and *zip* file:
<!-- markdown-link-check-enable -->
The commands which are necessary to generate [test.guide](https://www.tracetronic.com/products/test-guide/) reports are collected exemplarily in the [*example_TestSuite.py*](example_TestSuite.py). Run the example script to generate *json* and *zip* file:

```bash
python example_TestSuite.py
Expand All @@ -85,7 +73,7 @@ python example_TestSuite.py

The elements follow the hierarchy `TestSuite --> TestCaseFolder --> TestCase --> TestStepFolder --> TestStep`. So, instances of *TestCase(Folder)* are added to *TestSuite*, and instances of *TestStep(Folder)* are added to *TestCase*. At least one *TestCase* or *TestStep* has to be added to the respective folder (see [Restrictions](#restrictions)).

In the end, the report generator will take the assembled *TestSuite* and generate the report. The generator output is a *.json* report and a *.zip* file containing the generated test report along with possible testcase artifacts. The *.zip* file can be uploaded to TEST-GUIDE via the appropriate option in TEST-GUIDE. The schema of the *.json* which [TEST-GUIDE](https://www.tracetronic.com/products/test-guide/) expects can be found [here](testguide_report_generator/schema/schema.json).
In the end, the report generator will take the assembled *TestSuite* and generate the report. The generator output is a *.json* report and a *.zip* file containing the generated test report along with possible testcase artifacts. The *.zip* file can be uploaded to test.guide via the appropriate option in test.guide. The schema of the *.json* which [test.guide](https://www.tracetronic.com/products/test-guide/) expects can be found [here](testguide_report_generator/schema/schema.json).

A small example may look like this:

Expand Down Expand Up @@ -119,9 +107,7 @@ if __name__ == "__main__":
create_testsuite()
```
<!-- markdown-link-check-disable -->
A more extensive example is given in [example_TestSuite.py](/example_TestSuite.py).
<!-- markdown-link-check-enable -->
A more extensive example is given in [example_TestSuite.py](example_TestSuite.py).

### Available classes and their purpose

Expand Down Expand Up @@ -161,7 +147,7 @@ A complete specification can be found in the [schema](testguide_report_generator
## Contribution

At the moment, no external contributions are intended and merge requests from forks will automatically be **rejected**! However,
we do encourage you to file bugs and request features via the <!-- markdown-link-check-disable --> [issue tracker](https://github.com/tracetronic/testguide_json_generator_python/issues). <!-- markdown-link-check-enable -->
we do encourage you to file bugs and request features via the [issue tracker](https://github.com/tracetronic/testguide_report-generator/issues).

## Documentation

Expand Down
4 changes: 2 additions & 2 deletions config/license/allowlist.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
"allowedLicenses": [
{
"moduleLicense": "MIT",
"moduleVersion": "23.1.0",
"moduleVersion": "23.2.0",
"moduleName": "attrs",
"licenseUrl": "https://github.com/python-attrs/attrs/blob/23.1.0/LICENSE",
"licenseUrl": "https://github.com/python-attrs/attrs/blob/23.2.0/LICENSE",
"moduleCopyright": "Copyright (c) 2015 Hynek Schlawack and the attrs contributors",
"actualLicense": "MIT",
"violationAllowance": ""
Expand Down
2 changes: 1 addition & 1 deletion config/license/check_dependencies.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand Down
2 changes: 1 addition & 1 deletion conftest.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand Down
2 changes: 1 addition & 1 deletion default.pylintrc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2022-2023 TraceTronic GmbH
# Copyright (c) 2022-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand Down
Binary file modified docs/images/Logo_TEST-GUIDE_rgb_SCREEN.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/platform_logo.png
Binary file not shown.
6 changes: 3 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand All @@ -15,8 +15,8 @@
sys.path.insert(0, os.path.abspath("../.."))

project = 'testguide_report_generator'
copyright = '2023 TraceTronic GmbH'
author = 'TraceTronic GmbH'
copyright = '2023-2024 tracetronic GmbH'
author = 'tracetronic GmbH'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
Expand Down
6 changes: 3 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
..
Copyright (c) 2022 TraceTronic GmbH
Copyright (c) 2022-2024 tracetronic GmbH
SPDX-License-Identifier: MIT

Expand All @@ -8,8 +8,8 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to TEST-GUIDE JSON Generator documentation
==================================================
Welcome to test.guide Report Generator documentation
====================================================

.. toctree::
:maxdepth: 2
Expand Down
2 changes: 1 addition & 1 deletion example_TestSuite.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2022-2023 TraceTronic GmbH
# Copyright (c) 2022-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand All @@ -9,8 +9,8 @@ build-backend = "poetry.core.masonry.api"
[tool.poetry]
name = "testguide_report-generator"
version = "1.1-beta"
description = "This generator acts as a helper to create a TEST-GUIDE compatible test report."
authors = [ "TraceTronic GmbH",]
description = "This generator acts as a helper to create a test.guide compatible test report."
authors = [ "tracetronic GmbH",]
readme = "README.md"

[tool.poetry.dependencies]
Expand Down
6 changes: 3 additions & 3 deletions testguide_report_generator/ReportGenerator.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand All @@ -22,9 +22,9 @@
class Generator:
"""
This class is responsible for the creation of the `.zip` file containing the test report and
possible artifacts, which can be uploaded to TEST-GUIDE. An object of type
possible artifacts, which can be uploaded to test.guide. An object of type
:class:`TestSuite<testguide_report_generator.TestSuite.TestSuite>` is necessary, containing the
information about all testcases in a format compliant with the `TEST-GUIDE schema.json`. It
information about all testcases in a format compliant with the `test.guide schema.json`. It
is possible that the `.json` generated from the TestSuite object is not compliant with the
schema, for instance, if the suite does not contain any testcases. For further information,
please conduct the README.
Expand Down
2 changes: 1 addition & 1 deletion testguide_report_generator/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Copyright (c) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT
6 changes: 3 additions & 3 deletions testguide_report_generator/model/TestCase.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2023 TraceTronic GmbH
# Copyright (c) 2023-2024 tracetronic GmbH
#
# SPDX-License-Identifier: MIT

Expand Down Expand Up @@ -363,7 +363,7 @@ def create_json_repr(self):

class TestStepFolder(Json2AtxRepr):
"""
ATX-TestStepFolder. Each teststep folder must contain at least one TestStep to be TEST-GUIDE
ATX-TestStepFolder. Each teststep folder must contain at least one TestStep to be test.guide
compliant.
"""

Expand Down Expand Up @@ -431,7 +431,7 @@ def create_json_repr(self):
class TestCase(Json2AtxRepr):
"""
ATX-TestCase to be added to a :class:`TestSuite<testguide_report_generator.TestSuite.TestSuite>`. Each
TestSuite must contain at least one testcase to be TEST-GUIDE compliant (or, alternatively,
TestSuite must contain at least one testcase to be test.guide compliant (or, alternatively,
at least one :class:`TestCaseFolder<testguide_report_generator.TestCaseFolder.TestCaseFolder>`).
"""

Expand Down
Loading

0 comments on commit a071867

Please sign in to comment.