1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
|
%global _empty_manifest_terminate_build 0
Name: python-covimerage
Version: 0.2.2
Release: 1
Summary: Generate coverage information for Vim scripts.
License: MIT License
URL: https://github.com/Vimjas/covimerage
Source0: https://mirrors.aliyun.com/pypi/web/packages/e7/fd/45a6ce480ac42e53b5d6cf6c8c93620e5d2ba39060df2713fff00651e2de/covimerage-0.2.2.tar.gz
BuildArch: noarch
Requires: python3-attrs
Requires: python3-click
Requires: python3-coverage
Requires: python3-pytest
Requires: python3-pytest-mock
Requires: python3-flake8
Requires: python3-isort
Requires: python3-pdbpp
Requires: python3-pytest-pdb
Requires: python3-flake8
Requires: python3-isort
Requires: python3-pytest
Requires: python3-pytest-mock
%description
# covimerage
Generates code coverage information for Vim scripts.
It parses the output from Vim's `:profile` command, and generates data
compatible with [Coverage.py](http://coverage.readthedocs.io/).
[](https://circleci.com/gh/Vimjas/covimerage)
[](https://codecov.io/gh/Vimjas/covimerage/branch/master)
[](https://www.codacy.com/app/blueyed/covimerage)
## Installation
You can install covimerage using pip:
```sh
pip install covimerage
```
## Simple usage
You can use `covimerage run` to wrap the call to Neovim/Vim with necessary
boilerplate:
```sh
covimerage run vim -Nu test/vimrc -c 'Vader! test/**'
```
This will write the file `.coverage_covimerage` by default (use `--data-file`
to configure it), which is compatible with Coverage.py.
A report is automatically generated (on stdout).
You can then call `covimerage xml` to create a `coverage.xml` file
(Cobertura-compatible), which tools like [Codecov](https://codecov.io/)'s
`codecov` tool can consume, e.g. via `codecov -f coverage.xml`.
## Manual/advanced usage
### 1. Generate profile information for your Vim script(s)
You have to basically add the following to your tests vimrc:
```vim
profile start /tmp/vim-profile.txt
profile! file ./*
```
This makes Neovim/Vim then write a file with profiling information.
### 2. Call covimerage on the output file(s)
```sh
covimerage write_coverage /tmp/vim-profile.txt
```
This will create a file `.coverage_covimerage` (the default for `--data-file`),
with entries marked for processing by a
[Coverage.py](http://coverage.readthedocs.io/) plugin (provided by
covimerage)).
### 3. Include the covimerage plugin in .coveragerc
When using `coverage` on the generated output (data file), you need to add
the `covimerage` plugin to the `.coveragerc` file (which Coverage.py uses).
This is basically all the `.coveragerc` you will need, but you could use
other settings here (for Coverage.py), e.g. to omit some files:
```
[run]
plugins = covimerage
data_file = .coverage_covimerage
```
### 4. Create the report(s)
You can now call e.g. `coverage report -m`, and you should be able to use
coverage reporting platforms like <https://codecov.io/> or
<https://coveralls.io>, which are basically using `coverage xml`.
## Reference implementation
- [Neomake](https://github.com/neomake/neomake) is the first adopter of this.
It has an advanced test setup (including Docker based builds), and looking at
tis setup could be helpful when setting up covimerage for your
plugin/project.
- [Neomake's coverage report on codecov.io](https://codecov.io/gh/neomake/neomake/tree/master)
- [PR/change to integrate it in
Neomake](https://github.com/neomake/neomake/pull/1600) (Neomake's test
setup is rather advanced, so do not let that scare you!)
## Caveats
Coverage information for a function may get wiped if the function is re-defined
after testing it. This is a known limitation that does not depend on the
implementation of covimerage, but on the vim profiler itself, since profiling
data for a function, used to extract coverage data, is reset when the function
is re-defined, even if the definition is identical.
This can be an issue if the source files being checked for coverage are
reloaded with `runtime` between tests for some reasons, e.g. when mocking some
function. To prevent coverage information from being lost, one solution is to
write such tests in a different suite that is run separately, and combine the
coverage results with `covimerage run --append`.
## Links
- Discussion in Coverage.py's issue tracker:
[coverage issue 607](https://bitbucket.org/ned/coveragepy/issues/607/)
## TODO
- Line hit counts: known to covimerage, but not supported by Coverage.py
(<https://bitbucket.org/ned/coveragepy/issues/607/#comment-40048034>).
%package -n python3-covimerage
Summary: Generate coverage information for Vim scripts.
Provides: python-covimerage
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-covimerage
# covimerage
Generates code coverage information for Vim scripts.
It parses the output from Vim's `:profile` command, and generates data
compatible with [Coverage.py](http://coverage.readthedocs.io/).
[](https://circleci.com/gh/Vimjas/covimerage)
[](https://codecov.io/gh/Vimjas/covimerage/branch/master)
[](https://www.codacy.com/app/blueyed/covimerage)
## Installation
You can install covimerage using pip:
```sh
pip install covimerage
```
## Simple usage
You can use `covimerage run` to wrap the call to Neovim/Vim with necessary
boilerplate:
```sh
covimerage run vim -Nu test/vimrc -c 'Vader! test/**'
```
This will write the file `.coverage_covimerage` by default (use `--data-file`
to configure it), which is compatible with Coverage.py.
A report is automatically generated (on stdout).
You can then call `covimerage xml` to create a `coverage.xml` file
(Cobertura-compatible), which tools like [Codecov](https://codecov.io/)'s
`codecov` tool can consume, e.g. via `codecov -f coverage.xml`.
## Manual/advanced usage
### 1. Generate profile information for your Vim script(s)
You have to basically add the following to your tests vimrc:
```vim
profile start /tmp/vim-profile.txt
profile! file ./*
```
This makes Neovim/Vim then write a file with profiling information.
### 2. Call covimerage on the output file(s)
```sh
covimerage write_coverage /tmp/vim-profile.txt
```
This will create a file `.coverage_covimerage` (the default for `--data-file`),
with entries marked for processing by a
[Coverage.py](http://coverage.readthedocs.io/) plugin (provided by
covimerage)).
### 3. Include the covimerage plugin in .coveragerc
When using `coverage` on the generated output (data file), you need to add
the `covimerage` plugin to the `.coveragerc` file (which Coverage.py uses).
This is basically all the `.coveragerc` you will need, but you could use
other settings here (for Coverage.py), e.g. to omit some files:
```
[run]
plugins = covimerage
data_file = .coverage_covimerage
```
### 4. Create the report(s)
You can now call e.g. `coverage report -m`, and you should be able to use
coverage reporting platforms like <https://codecov.io/> or
<https://coveralls.io>, which are basically using `coverage xml`.
## Reference implementation
- [Neomake](https://github.com/neomake/neomake) is the first adopter of this.
It has an advanced test setup (including Docker based builds), and looking at
tis setup could be helpful when setting up covimerage for your
plugin/project.
- [Neomake's coverage report on codecov.io](https://codecov.io/gh/neomake/neomake/tree/master)
- [PR/change to integrate it in
Neomake](https://github.com/neomake/neomake/pull/1600) (Neomake's test
setup is rather advanced, so do not let that scare you!)
## Caveats
Coverage information for a function may get wiped if the function is re-defined
after testing it. This is a known limitation that does not depend on the
implementation of covimerage, but on the vim profiler itself, since profiling
data for a function, used to extract coverage data, is reset when the function
is re-defined, even if the definition is identical.
This can be an issue if the source files being checked for coverage are
reloaded with `runtime` between tests for some reasons, e.g. when mocking some
function. To prevent coverage information from being lost, one solution is to
write such tests in a different suite that is run separately, and combine the
coverage results with `covimerage run --append`.
## Links
- Discussion in Coverage.py's issue tracker:
[coverage issue 607](https://bitbucket.org/ned/coveragepy/issues/607/)
## TODO
- Line hit counts: known to covimerage, but not supported by Coverage.py
(<https://bitbucket.org/ned/coveragepy/issues/607/#comment-40048034>).
%package help
Summary: Development documents and examples for covimerage
Provides: python3-covimerage-doc
%description help
# covimerage
Generates code coverage information for Vim scripts.
It parses the output from Vim's `:profile` command, and generates data
compatible with [Coverage.py](http://coverage.readthedocs.io/).
[](https://circleci.com/gh/Vimjas/covimerage)
[](https://codecov.io/gh/Vimjas/covimerage/branch/master)
[](https://www.codacy.com/app/blueyed/covimerage)
## Installation
You can install covimerage using pip:
```sh
pip install covimerage
```
## Simple usage
You can use `covimerage run` to wrap the call to Neovim/Vim with necessary
boilerplate:
```sh
covimerage run vim -Nu test/vimrc -c 'Vader! test/**'
```
This will write the file `.coverage_covimerage` by default (use `--data-file`
to configure it), which is compatible with Coverage.py.
A report is automatically generated (on stdout).
You can then call `covimerage xml` to create a `coverage.xml` file
(Cobertura-compatible), which tools like [Codecov](https://codecov.io/)'s
`codecov` tool can consume, e.g. via `codecov -f coverage.xml`.
## Manual/advanced usage
### 1. Generate profile information for your Vim script(s)
You have to basically add the following to your tests vimrc:
```vim
profile start /tmp/vim-profile.txt
profile! file ./*
```
This makes Neovim/Vim then write a file with profiling information.
### 2. Call covimerage on the output file(s)
```sh
covimerage write_coverage /tmp/vim-profile.txt
```
This will create a file `.coverage_covimerage` (the default for `--data-file`),
with entries marked for processing by a
[Coverage.py](http://coverage.readthedocs.io/) plugin (provided by
covimerage)).
### 3. Include the covimerage plugin in .coveragerc
When using `coverage` on the generated output (data file), you need to add
the `covimerage` plugin to the `.coveragerc` file (which Coverage.py uses).
This is basically all the `.coveragerc` you will need, but you could use
other settings here (for Coverage.py), e.g. to omit some files:
```
[run]
plugins = covimerage
data_file = .coverage_covimerage
```
### 4. Create the report(s)
You can now call e.g. `coverage report -m`, and you should be able to use
coverage reporting platforms like <https://codecov.io/> or
<https://coveralls.io>, which are basically using `coverage xml`.
## Reference implementation
- [Neomake](https://github.com/neomake/neomake) is the first adopter of this.
It has an advanced test setup (including Docker based builds), and looking at
tis setup could be helpful when setting up covimerage for your
plugin/project.
- [Neomake's coverage report on codecov.io](https://codecov.io/gh/neomake/neomake/tree/master)
- [PR/change to integrate it in
Neomake](https://github.com/neomake/neomake/pull/1600) (Neomake's test
setup is rather advanced, so do not let that scare you!)
## Caveats
Coverage information for a function may get wiped if the function is re-defined
after testing it. This is a known limitation that does not depend on the
implementation of covimerage, but on the vim profiler itself, since profiling
data for a function, used to extract coverage data, is reset when the function
is re-defined, even if the definition is identical.
This can be an issue if the source files being checked for coverage are
reloaded with `runtime` between tests for some reasons, e.g. when mocking some
function. To prevent coverage information from being lost, one solution is to
write such tests in a different suite that is run separately, and combine the
coverage results with `covimerage run --append`.
## Links
- Discussion in Coverage.py's issue tracker:
[coverage issue 607](https://bitbucket.org/ned/coveragepy/issues/607/)
## TODO
- Line hit counts: known to covimerage, but not supported by Coverage.py
(<https://bitbucket.org/ned/coveragepy/issues/607/#comment-40048034>).
%prep
%autosetup -n covimerage-0.2.2
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-covimerage -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Thu Jun 08 2023 Python_Bot <Python_Bot@openeuler.org> - 0.2.2-1
- Package Spec generated
|
