Task request for beem: bug-hunting

in #utopian-io8 years ago (edited)

Repository

https://github.com/holgern/beem

beem-logo.png

About beem

beem is an unofficial python library for steem, which I created from scratch by forking python-bitshares. The library name is derived from a beam maschine, similar to the analogy between steem and steam. A documentation about beem can be found here: http://beem.readthedocs.io/en/latest/.

I pushed the first commit on the 14 Feb. 2018 to github. Since then, the code base was growing from 5288 lines of python code to 18232 lines of code.


image.png

The current version is 0.19.35 and it contains the following features:

  • RPC interface (ttps and websocket) for full API nodes
  • Node failure handling
  • Support for almost all steem API calls
  • JSON-based blockchain objects (accounts, votes, comments, blocks, prices, markets, etc)
  • a simple to use yet powerful API
  • transaction construction and signing
  • appbase ready
  • steemconnect v2 integration
  • it’s own (bip32-encrypted) wallet for key and token storage
  • command line tool beempy

Although the total test coverage is on a good level (78% currently), it is not everything covered. High code coverage does also not mean that the code cannot contain bugs anymore. It shows that the code can run without error and returns the predefined output for certain input data.


image.png

Manual testing remains very important for beem, due to the high number of code lines and the huge functionality which beem has to offer. So, I'm asking everyone to help me improving beem, by finding bugs in beem.

Details / Components

This task request is about finding bugs inside the python library beem.
This includes all function inside the following python modules:

  • beem
  • beemapi
  • beembase
  • beemgraphenebase

The request is not about errors that occurred in installing dependent python libraries (e.g. scrypt).

Content of a good bug hunting post

A good bug hunting post must contain the following sections:

Expected behavior

Please describe in detail about the expected behavior. "It must return a value", or similar platitudes are not sufficient. After reading this section, it must be clear, what the expected behavior is. This helps me to understand the described error.

  • Example (not related to beem):
    The int_sum function should return the sum of two integer numbers.

Actual behavior

Please describe shortly about the current situation. "It does not work", is not sufficient.

  • Example (not related to beem):
    When one number is zero, the int_sum function returns zero instead of the other non-zero number.

How to reproduce

A python script with output, which is able to reproduce the described error, helps a lot in finding the source of the error.

  • Example (not related to beem):
import int_sum
x = int_sum(0, 1)
print(x)

Output:

0

Environment

The used python and beem version is important for repoducing the error (Different behavior for unicode strings on python 2.7 and 3.6, for example).
The beem version can be obtained by beempy --version.

Creating an issue on https://github.com/holgern/beem

After writing a utopian-io post about a bug, a new issue should be created in the beem github repo: https://github.com/holgern/beem/issues/new. This is important for collecting all bug reports in one place and for mention it when fixing it.

Deadline

This task request has no deadline, as it will stay open.

Communication

For more information please visit the beem discord server: https://discord.gg/4HM592V

Github

https://github.com/holgern

Sort:  

I plan on building a GUI for upvoting content that will integrate beem. If I come across any bugs I'll let you know.

Hello @holger80,
Thank you for submitting this task request and bringing your project open with Utopian.

  • Your report is well-defined.
  • Proper Steps and requirements are provided
  • what you expect is the bug-report is clearly stated in this task
  • This task is open for as long as required.

Your contribution has been evaluated according to Utopian policies and guidelines, as well as a predefined set of questions pertaining to the category.

To view those questions and the relevant answers related to your post, click here.


Need help? Write a ticket on https://support.utopian.io/.
Chat with us on Discord.
[utopian-moderator]

Hey @holger80
Thanks for contributing on Utopian.
We’re already looking forward to your next task request!

Contributing on Utopian
Learn how to contribute on our website or by watching this tutorial on Youtube.

Want to chat? Join us on Discord https://discord.gg/h52nFrV.

Vote for Utopian Witness!