Skip to content

Commit 2b42b3d

Browse files
m-mcgowanm-mcgowan
authored
feat: add coveralls reporting for this repo. (#57)
feat: add coveralls reporting for this repo.
1 parent 73cf920 commit 2b42b3d

File tree

10 files changed

+341
-1
lines changed

10 files changed

+341
-1
lines changed

‎.github/actions/publish-coverage/Dockerfile

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Container with dependencies necessary to run unit-tests and code coverage
2+
3+
# Build development environment
4+
# $ docker build . --tag note-arduino-coverage
5+
6+
# Launch development environment (mount source root as /note-arduino/)
7+
# $ docker run --rm --volume $(pwd)/../../../:/note-arduino/ --workdir /note-arduino/ note-arduino-coverage
8+
9+
10+
# Base Image - here we reuse the test image since it has all the dependencies required
11+
FROM alpine
12+
13+
RUN apk add py3-pip && pip install requests
14+
15+
ENTRYPOINT ["ash", "-c", "./.github/actions/publish-coverage/publish-to-coveralls.sh"]

‎.github/actions/publish-coverage/action.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
name: 'Publish Coverage'
2+
description: 'Publish test coverage report to coveralls'
3+
runs:
4+
using: 'docker'
5+
image: 'Dockerfile'

‎.github/actions/publish-coverage/publish-to-coveralls.sh

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# publishes the coveralls report to coveralls.io
2+
# Requires COVERALLS_REPO_TOKEN environment variable to contain the access token generated by coveralls.
3+
4+
result=0
5+
if [ -f coverage.json ]; then
6+
python3 .github/actions/publish-coverage/report/report.py coverage.json
7+
if [ 0 -ne $? ]; then
8+
echo "Unable to publish coverage report!"
9+
result=1
10+
fi
11+
else
12+
echo "File coverage.json does not exist"
13+
result=2
14+
fi
15+
exit $result

‎.github/actions/publish-coverage/report/LICENSE

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS

‎.github/actions/publish-coverage/report/report.py

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
#!/usr/bin/env python
2+
"""Module to upload Python JSON structure to Coveralls.io"""
3+
# -*- coding:utf-8 -*-
4+
5+
from __future__ import absolute_import
6+
from __future__ import print_function
7+
8+
__author__ = 'Lei Xu <[email protected]>'
9+
__version__ = '0.4.2'
10+
11+
__classifiers__ = [
12+
'Development Status :: 3 - Alpha',
13+
'Intended Audience :: Developers',
14+
'License :: OSI Approved :: Apache Software License',
15+
'Operating System :: OS Independent',
16+
'Programming Language :: Python',
17+
'Programming Language :: Python :: 3',
18+
'Topic :: Internet :: WWW/HTTP',
19+
'Topic :: Software Development :: Libraries',
20+
'Topic :: Software Development :: Quality Assurance',
21+
'Topic :: Utilities',
22+
]
23+
24+
__copyright__ = '2019, %s ' % __author__
25+
__license__ = """
26+
Copyright %s.
27+
Licensed under the Apache License, Version 2.0 (the "License");
28+
you may not use this file except in compliance with the License.
29+
You may obtain a copy of the License at
30+
http://www.apache.org/licenses/LICENSE-2.0
31+
Unless required by applicable law or agreed to in writing, software
32+
distributed under the License is distributed on an "AS IS" BASIS,
33+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either expressed or implied.
34+
See the License for the specific language governing permissions and
35+
limitations under the License.
36+
""" % __copyright__
37+
38+
# Filename: report.py
39+
# Author: Lei "Eddy" Xu
40+
# Copyright: 2019 Lei Xu
41+
# Description: Module to upload Python JSON structure to Coveralls.io
42+
# License: Apache License, Version 2.0
43+
# Modification History:
44+
# 2019/08/26 - Zachary J. Fields: Added main to support command line file upload
45+
46+
import requests
47+
import json
48+
import os
49+
import sys
50+
51+
URL = os.getenv('COVERALLS_ENDPOINT', 'https://coveralls.io') + "/api/v1/jobs"
52+
53+
class Args:
54+
skip_ssl_verify = False
55+
56+
57+
def post_report(coverage, args):
58+
"""Post coverage report to coveralls.io."""
59+
response = requests.post(URL, files={'json_file': json.dumps(coverage)},
60+
verify=(not args.skip_ssl_verify))
61+
try:
62+
result = response.json()
63+
except ValueError:
64+
result = {'error': 'Failure to submit data. '
65+
'Response [%(status)s]: %(text)s' % {
66+
'status': response.status_code,
67+
'text': response.text}}
68+
print(result)
69+
if 'error' in result:
70+
return result['error']
71+
return 0
72+
73+
def main():
74+
if (len(sys.argv) < 2):
75+
print("USAGE: python %s <coverage.json>" % sys.argv[0])
76+
else:
77+
args = Args()
78+
with open(sys.argv[1], 'r') as json_coverage_file:
79+
# Load coverage details from specified file
80+
json_coverage_details = json.load(json_coverage_file)
81+
82+
# Pull environment variables
83+
if (json_coverage_details['repo_token'] is None):
84+
json_coverage_details['repo_token'] = os.environ.get('COVERALLS_REPO_TOKEN')
85+
if (json_coverage_details['repo_token'] is None):
86+
print("Environment variable COVERALLS_REPO_TOKEN is required to upload coverage information")
87+
exit(-1)
88+
89+
# Consume Codefresh CI specific environment variables _(if available)_
90+
json_coverage_details['service_job_id'] = os.environ.get('CF_BUILD_ID')
91+
if (json_coverage_details['service_job_id'] is not None):
92+
json_coverage_details['service_name'] = "codefresh"
93+
else:
94+
json_coverage_details['service_name'] = ""
95+
del json_coverage_details['service_job_id']
96+
97+
# Post report to Coveralls.io
98+
post_report(json_coverage_details, args)
99+
100+
if __name__ == '__main__':
101+
main()

‎.github/actions/run-tests-in-container/Dockerfile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,18 @@
99
# Base Image
1010
FROM alpine
1111

12+
1213
# Testing Dependencies
14+
# install gcovr from the package manager, which gets most required dependencies (avoiding the need for libxml2-dev, libxslt-dev and setting the include path.)
15+
# then install using pip to get the 5.x line with support for coveralls formatted reports.
1316
RUN ["ash", "-c", "\
1417
apk add --no-cache \
1518
gcovr \
19+
py3-pip \
20+
python3-dev \
1621
g++ \
1722
valgrind \
23+
&& pip install -U gcovr \
1824
"]
1925

2026
ENTRYPOINT ["./test/run_all_tests.sh"]

‎.github/workflows/note-arduino-ci.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,9 @@ jobs:
1818
- name: Run Tests In Container
1919
id: containerized_tests
2020
uses: ./.github/actions/run-tests-in-container
21+
env:
22+
COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
23+
- name: Publish Test Coverage
24+
id: publish_coverage
25+
uses: ./.github/actions/publish-coverage
26+

‎.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,11 @@
22
.DS_Store
33
*.gch
44
*.out
5-
5+
*.gcda
6+
*.gcno
7+
*.gcov
68
Doxyfile*
79
doxygen_sqlite3.db
810
html
911
latex
12+
coverage.json

‎README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[![Coverage Status](https://coveralls.io/repos/github/blues/note-arduino/badge.svg?branch=master)](https://coveralls.io/github/blues/note-arduino?branch=master)
2+
13
# note-arduino
24

35
The note-arduino Arduino library for communicating with the

‎test/run_all_tests.sh

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,13 +115,23 @@ else
115115
fi
116116

117117
echo
118+
118119
if [ 0 -eq ${all_tests_result} ]; then
119120
echo 'All tests have passed!'
120121
gcovr --print-summary --sort-percentage --exclude-throw-branches --delete \
121122
--object-directory . \
122123
--root src \
123124
--exclude .*_error.* \
125+
--exclude test \
126+
--coveralls coverage.json \
127+
--txt \
124128
&& rm ./a.out *.gcno
129+
if [ ! -f "coverage.json" ]; then
130+
echo "Coverage report not produced";
131+
all_tests_result=997
132+
fi
125133
else
126134
echo 'TESTS FAILED!!!'
127135
fi
136+
137+
exit $all_tests_result

0 commit comments

Comments
 (0)