Plugin's test code exists at the source code file named argoslabs/myplugin/asciiart/tests/test_me.py.
There are good ways to test with several testing frameworks.
We are using unittest.
Below shows the full version of test_me.py.
"""
====================================
:mod:`argoslabs.myplugin.asciiart`
====================================
.. moduleauthor:: Your Name <name@yours>
.. note:: ARGOS-LABS License
Description
===========
ARGOS LABS plugin module to use Selenium
"""
# Authors
# ===========
#
# * Your Name
#
# Change Log
# --------
#
# * [2022/02/02]
# - starting
################################################################################
import os
import sys
from unittest import TestCase
from argoslabs.myplugin.asciiart import _main as main
################################################################################
class TU(TestCase):
# ==========================================================================
def setUp(self) -> None:
os.chdir(os.path.dirname(__file__))
# ==========================================================================
def test0000_init(self):
...
# ==========================================================================
def test0010_fail_empty(self):
# sg = sys.gettrace()
# if sg is None: # Not in debug mode
# print('Skip testing at test/build time')
# return
try:
_ = main('')
self.assertTrue(False)
except Exception as e:
sys.stderr.write('\n%s\n' % str(e))
self.assertTrue(True)
# ==========================================================================
def test0110_success(self):
of = 'stdout.txt'
try:
r = main('standard',
'Hello world?',
'--outfile', of)
self.assertTrue(r == 0)
with open(of) as ifp:
rs = ifp.read()
print(rs)
self.assertTrue(rs.strip() == r''' _ _ _ _ _ _ ___
| | | | ___| | | ___ __ _____ _ __| | __| |__ \
| |_| |/ _ \ | |/ _ \ \ \ /\ / / _ \| '__| |/ _` | / /
| _ | __/ | | (_) | \ V V / (_) | | | | (_| ||_|
|_| |_|\___|_|_|\___/ \_/\_/ \___/|_| |_|\__,_|(_)
'''.strip())
except Exception as e:
sys.stderr.write('\n%s\n' % str(e))
self.assertTrue(False)
finally:
if os.path.exists(of):
os.remove(of)
# ==========================================================================
def test0120_success_font(self):
of = 'stdout.txt'
try:
r = main('slant',
'Hello world?',
'--outfile', of)
self.assertTrue(r == 0)
with open(of) as ifp:
rs = ifp.read()
print(rs)
self.assertTrue(rs.strip() == r''' __ __ ____ __ _____
/ / / /__ / / /___ _ ______ _____/ /___/ /__ \
/ /_/ / _ \/ / / __ \ | | /| / / __ \/ ___/ / __ / / _/
/ __ / __/ / / /_/ / | |/ |/ / /_/ / / / / /_/ / /_/
/_/ /_/\___/_/_/\____/ |__/|__/\____/_/ /_/\__,_/ (_)
'''.strip())
except Exception as e:
sys.stderr.write('\n%s\n' % str(e))
self.assertTrue(False)
finally:
if os.path.exists(of):
os.remove(of)
# ==========================================================================
def test0130_success_direction(self):
of = 'stdout.txt'
try:
r = main('slant',
'Hello world?',
'--direction', 'right-to-left',
'--outfile', of)
self.assertTrue(r == 0)
with open(of) as ifp:
rs = ifp.read()
print(rs)
self.assertTrue(rs.strip() == r''' ___ ____ ____ __ __
/__ \____/ / /________ _ __ ____ / / /__ / / / /
/ _/ __ / / ___/ __ \ | /| / / / __ \/ / / _ \/ /_/ /
/_// /_/ / / / / /_/ / |/ |/ / / /_/ / / / __/ __ /
(_) \__,_/_/_/ \____/|__/|__/ \____/_/_/\___/_/ /_/
'''.strip())
except Exception as e:
sys.stderr.write('\n%s\n' % str(e))
self.assertTrue(False)
finally:
if os.path.exists(of):
os.remove(of)
# ==========================================================================
def test0140_success_justify(self):
of = 'stdout.txt'
try:
r = main('slant',
'Hello world?',
'--width', '44',
'--outfile', of)
self.assertTrue(r == 0)
with open(of) as ifp:
rs = ifp.read()
print(rs)
self.assertTrue(rs.strip() == r''' __ __ ____
/ / / /__ / / /___
/ /_/ / _ \/ / / __ \
/ __ / __/ / / /_/ /
/_/ /_/\___/_/_/\____/
__ _____
_ ______ _____/ /___/ /__ \
| | /| / / __ \/ ___/ / __ / / _/
| |/ |/ / /_/ / / / / /_/ / /_/
|__/|__/\____/_/ /_/\__,_/ (_)
'''.strip())
except Exception as e:
sys.stderr.write('\n%s\n' % str(e))
self.assertTrue(False)
finally:
if os.path.exists(of):
os.remove(of)
# ==========================================================================
def test9999_quit(self):
self.assertTrue(True)We are using uniitest, TestCase.
from argoslabs.myplugin.asciiart import _main as mainYou must refer to _main function of proper Python package like argoslabs.myplugin.asciiart.
- Every methods starting with
test...()methods are tested in the ascending order of alphabet. - setUp() method is a special method which called befoce every test case methods.
def setUp(self) -> None:
os.chdir(os.path.dirname(__file__))Usually this setup is changing the working folder of tests so reading or writing files using relative path.
Every test case have to check the _main(...) result code.
r = main(...)
self.assertTrue(r == 0)This return code is the same as plugin's return code.
0- On successNone 0- Otherwise Error
r = main('slant',
'Hello world?',
'--width', '44',
'--outfile', of)
self.assertTrue(r == 0)
with open(of) as ifp:
rs = ifp.read()
self.assertTrue(rs == r'...')--outfileis the saved file from pluginSTDOUToutput. This result is the passed toPAMso in this test you can test in this function working well or not- The most common advantage in this testcase is that we can use
IDE's debugging method.
When you update (fix bugs, add new function, or modify original code) plugin's code this test case is extremely important. Naturally, you add a new test case for the new functionality. However, testing for all of the previous test cases must be performed for every update. We call this Regression testing.
Two kinds of testing is possible:
- Outside of
TestCasewe can debug whole test cases like above example image. - When the cursor is in one of the test function and right click and select
Debugthen you can debug only that function.
When you test all cases you can see the process of passed or not at the left bottom side on PyCharm like above capture image.
You have to make sure every test case is passed. If not, the plugin build-up will fail.
You can open Terminal from the context menu, Open with > Terminal on right click of folder asciiart.
And run this command,
(py37) C:\work\plugin-template\argoslabs\myplugin\asciiart>alabs.ppm plugin unique
Package "argoslabs.myplugin.asciiart" and Display name "ASCII Art" seems OK to use.(py37)prompt means that you are inpy37virtual environment.- If there is an error message for this package name or display name please change it. Repeat until no error has been found.
- This
alabs.ppm plugin uniquecommand may takes long time - often more than 5 minutes because getting all modules from official repository- Note that this uniqueness is checking only with
official repositorynotprivate repositories. Your responsibility to check the uniqueness.- New version of
PyCharmchanged fromCMD.EXEintoPowerShell. So there may be no(py37)virtual environment prompt.