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

Add docs and tests for CRIT #76

Merged
merged 3 commits into from
Aug 11, 2022
Merged

Conversation

snprajwal
Copy link
Member

@snprajwal snprajwal commented Jul 22, 2022

This PR provides docs and tests for the crit library introduced in #66

  • Integration test
  • E2E test
  • Inline comments for LSP hover
  • Documentation on CRIU website

@snprajwal snprajwal mentioned this pull request Jul 22, 2022
12 tasks
crit/decode-extra.go Outdated Show resolved Hide resolved
crit/decode.go Outdated Show resolved Hide resolved
crit/decode.go Outdated Show resolved Hide resolved
crit/encode-extra.go Outdated Show resolved Hide resolved
crit/encode-extra.go Outdated Show resolved Hide resolved
crit/encode-extra.go Outdated Show resolved Hide resolved
crit/encode-extra.go Outdated Show resolved Hide resolved
crit/encode-extra.go Outdated Show resolved Hide resolved
crit/encode-extra.go Outdated Show resolved Hide resolved
crit/encode-extra.go Outdated Show resolved Hide resolved
crit/encode.go Outdated Show resolved Hide resolved
crit/explore.go Outdated Show resolved Hide resolved
crit/explore.go Outdated Show resolved Hide resolved
crit/explore.go Outdated Show resolved Hide resolved
crit/image.go Outdated Show resolved Hide resolved
crit/cmd/cli.go Outdated Show resolved Hide resolved
@snprajwal snprajwal force-pushed the crit branch 3 times, most recently from 6b808b6 to bf6259b Compare July 31, 2022 10:22
@codecov-commenter
Copy link

codecov-commenter commented Jul 31, 2022

Codecov Report

Merging #76 (4935e97) into master (9eea1cb) will not change coverage.
The diff coverage is n/a.

❗ Current head 4935e97 differs from pull request most recent head b5c07fc. Consider uploading reports for the commit b5c07fc to get more accurate results

@@           Coverage Diff           @@
##           master      #76   +/-   ##
=======================================
  Coverage   51.38%   51.38%           
=======================================
  Files           2        2           
  Lines         288      288           
=======================================
  Hits          148      148           
  Misses        105      105           
  Partials       35       35           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

test/crit/crit-test.sh Outdated Show resolved Hide resolved
test/Makefile Outdated Show resolved Hide resolved
@snprajwal snprajwal force-pushed the crit branch 3 times, most recently from dd30b00 to 748a36e Compare August 6, 2022 07:50
test/crit/main.go Outdated Show resolved Hide resolved
test/crit/main.go Show resolved Hide resolved
test/crit/main.go Outdated Show resolved Hide resolved
test/crit/main.go Outdated Show resolved Hide resolved
test/crit/main.go Outdated Show resolved Hide resolved
test/crit/main.go Outdated Show resolved Hide resolved
test/crit/main.go Outdated Show resolved Hide resolved
test/crit/Makefile Outdated Show resolved Hide resolved
test/crit/Makefile Outdated Show resolved Hide resolved
test/crit/crit-test.sh Outdated Show resolved Hide resolved
@snprajwal snprajwal marked this pull request as ready for review August 10, 2022 15:38
This commit provides inline documentation that can be used by language
servers upon hover. It also adds comments for the internal functions in
order to explain their functionality better.

Signed-off-by: Prajwal S N <prajwalnadig21@gmail.com>
The end-to-end test uses a simple C program to generate image files
and test all commands provided by the crit CLI.

Signed-off-by: Prajwal S N <prajwalnadig21@gmail.com>
This test performs decode and encode on an image file and compares the
result with the original file. The test passes if both files are
equivalent byte for byte.

Signed-off-by: Prajwal S N <prajwalnadig21@gmail.com>
Copy link
Member

@rst0git rst0git left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@rst0git rst0git merged commit b7262e1 into checkpoint-restore:master Aug 11, 2022
@snprajwal snprajwal deleted the crit branch August 11, 2022 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants