Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add github templates #124

Merged
merged 7 commits into from
Jun 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 86 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
name: Bug Report
description: File a bug report
title: "<Please write a short description of what didn't work for you here>"
labels: ["Bug", "Pending Triage"]
body:
- type: input
id: bom-cli-version
attributes:
label: Bill of Materials or CLI Version
description: Which version of the BOM or CLI are you using?
placeholder: |
ex. 0.18.2 or git commit ID

The bill of materials version can be found in your Gradle or Maven
build configuration. The CLI version can be found by using the `--version` switch.
- type: dropdown
id: execution-environment
attributes:
label: Execution Environment
description: Which front-end execution environment are you using?
options:
- JUnit Extensions
- Performance CLI
- Local Node CLI
- Other
validations:
required: true
- type: dropdown
id: logging-implementation
attributes:
label: Slf4j Logging Implementation
description: Which slf4j compatible logging implementation are you using? **JUnit Users Only**
options:
- Log4j 1.x
- Log4j 2.x
- Logback Classic
- Other
validations:
required: false
- type: textarea
id: reproduction-steps
attributes:
label: To Reproduce
description: Steps to reproduce the behavior
render: markdown
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true
- type: textarea
id: actual-behavior
attributes:
label: Describe the bug
description: Also tell us, what did happen?
placeholder: A clear and concise description of what happened.
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Describe the expected behavior
description: Also tell us, what did you expect to happen?
placeholder: A clear and concise description of what the expected behavior is.
validations:
required: true
- type: textarea
id: test-cli-logs
attributes:
label: Whole JUnit/CLI Logs
description: "NEVER EVER OMIT THIS! Include logs from JUnit test output or CLI console/log file output. Don't omit the parts you think irrelevant!"
render: shell
placeholder: |
PROVIDE THE LOGS VIA A GIST LINK (https://gist.github.com/), NOT DIRECTLY IN THIS TEXT AREA
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: |
Add any other context about the problem here.

Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Feature Enhancement
description: Enhance an existing feature
title: "<Please write a brief description of the feature enhancement here>"
labels: ["Feature Enhancement", "Pending Triage"]
body:
- type: textarea
id: target-feature
attributes:
label: Feature to Enhance
description: Which existing feature would you like to enhance?
render: markdown
placeholder: |
_A clear and concise description of the feature you want to enhance._
validations:
required: true
- type: textarea
id: enhancement-description
attributes:
label: Requested Enhancement
description: What would you like to enhance or change about this feature?
render: markdown
placeholder: |
_A clear and concise description of what you want to happen._

Note: Feature enhancements to integrate vendor specific cloud tools (e.g. awscli, gcloud-sdk, azure-cli) will likely be rejected as the Full Stack Testing (FST) Suite aims to be vendor agnostic.
validations:
required: true
- type: textarea
id: feature-justification
attributes:
label: Business Need
description: Why is this needed?
render: markdown
placeholder: |
_A clear and concise description of any alternative solutions or other features you've considered._

Note: Please provide a clear and concise description of the business need for this enhancement. This will help us prioritize the feature request.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: |
Add any other context or screenshots about the feature request here.

Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: New Feature
description: Request a new feature
title: "<Please write a brief description of the new feature here>"
labels: ["New Feature", "Pending Triage"]
body:
- type: textarea
id: feature-description
attributes:
label: Requested Feature
description: What would you like added?
render: markdown
placeholder: |
_A clear and concise description of what you want to happen._

Note: Feature requests to integrate vendor specific cloud tools (e.g. awscli, gcloud-sdk, azure-cli) will likely be rejected as the Full Stack Testing (FST) Suite aims to be vendor agnostic.
validations:
required: true
- type: textarea
id: feature-justification
attributes:
label: Business Need
description: Why is this needed?
render: markdown
placeholder: |
_A clear and concise description of any alternative solutions or features you've considered._

Note: Please provide a clear and concise description of the business need for this feature. This will help us prioritize the feature request.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: |
Add any other context or screenshots about the feature request here.

Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
17 changes: 17 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
version: 2
updates:
- package-ecosystem: "gradle"
directory: "/"
schedule:
interval: "daily"
open-pull-requests-limit: 10
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
open-pull-requests-limit: 5
- package-ecosystem: "docker"
directory: "/docker"
schedule:
interval: "weekly"
open-pull-requests-limit: 5
9 changes: 9 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
## Description

This pull request changes the following:

- TBD

### Related Issues

- Closes #
16 changes: 16 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
#
# Copyright (C) 2023 Hedera Hashgraph, LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

FROM registry.access.redhat.com/ubi8/ubi-init:latest
ENV COMPOSE_VERSION 2.16.0
ENV GO_VERSION 1.20.2
Expand Down
34 changes: 32 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,32 @@
# full-stack-testing
JUnit 5 extensions and supporting libraries for performing Full Stack testing of the Hedera Services application.
# Full Stack Testing (FST) Suite

[![Build Application](https://github.com/hashgraph/full-stack-testing/actions/workflows/flow-build-application.yaml/badge.svg?event=push)](https://github.com/hashgraph/full-stack-testing/actions/workflows/flow-build-application.yaml)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=com.hedera%3Afull-stack-testing&metric=coverage&token=9c0b92ee625fdb845e839ce29e2e61d8775e967e)](https://sonarcloud.io/summary/new_code?id=com.hedera%3Afull-stack-testing)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=com.hedera%3Afull-stack-testing&metric=alert_status&token=9c0b92ee625fdb845e839ce29e2e61d8775e967e)](https://sonarcloud.io/summary/new_code?id=com.hedera%3Afull-stack-testing)
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=com.hedera%3Afull-stack-testing&metric=ncloc&token=9c0b92ee625fdb845e839ce29e2e61d8775e967e)](https://sonarcloud.io/summary/new_code?id=com.hedera%3Afull-stack-testing)
[![codecov](https://codecov.io/github/hashgraph/full-stack-testing/branch/main/graph/badge.svg?token=ABNne1KOxE)](https://codecov.io/github/hashgraph/full-stack-testing)

The Full Stack Testing (FST) Suite provides a framework and an associated set of tools for conducting
end-to-end and full stack tests against the Hedera network software. Designed with ease of use in mind, the tools are
purpose built for the Hedera community and open-source contributors.

## Current Status

The FST Suite is currently under **active development** and is not yet ready for general use.

## Support

If you have a question on how to use the product, please see our [support guide](https://github.com/hashgraph/.github/blob/main/SUPPORT.md).

## Contributing

Contributions are welcome. Please see the [contributing guide](https://github.com/hashgraph/.github/blob/main/CONTRIBUTING.md) to see how you can get involved.

## Code of Conduct

This project is governed by the [Contributor Covenant Code of Conduct](https://github.com/hashgraph/.github/blob/main/CODE_OF_CONDUCT.md). By participating, you are
expected to uphold this code of conduct.

## License

[Apache License 2.0](LICENSE)
21 changes: 21 additions & 0 deletions codecov.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
codecov:
max_report_age: off
require_ci_to_pass: true
comment:
behavior: default
layout: reach,diff,flags,tree,reach
show_carryforward_flags: false
coverage:
precision: 2
range:
- 60.0
- 80.0
round: down
status:
changes: false
default_rules:
flag_coverage_not_uploaded_behavior: include
patch: true
project: true
github_checks:
annotations: true