5 months agoAlphabetize entries in command data file
Jeremy Stanley [Sun, 2 May 2021 19:07:34 +0000 (19:07 +0000)]
Alphabetize entries in command data file

The refactoring which led to the evaluate debug command left it out
of alpha order in share/command.yaml, so correct that now.

5 months agoBe more robust with elapsed time counter 0.4.0
Jeremy Stanley [Mon, 26 Apr 2021 01:21:45 +0000 (01:21 +0000)]
Be more robust with elapsed time counter

Stress testing identified a rare startup race if a user connected
before the elapsed time counter was initialized. The odds of
encountering this in the wild are close to nonexistent, but it was
introducing occasional test failures.

Solve the race by reordering the actions taken on each pulse, so
that the counter is initialized before the listening socket is
created. Also force all access to the counter through setter/getter
methods and wrap in try/except to always return a value and properly
create the counter and containing element if it doesn't yet exist.

5 months agoRetry client connections in selftest
Jeremy Stanley [Sat, 17 Apr 2021 16:07:33 +0000 (16:07 +0000)]
Retry client connections in selftest

Replace a hard-coded delay after process start with a dynamic client
connection retry, which attempts to connect up to five times with
the first being immediate while subsequent connections observe an
exponential backoff over a three-second period before giving up.
This improves both speed and stability of test runs.

Also combine the ConnectionResetError and EOFError conditions which
could be raised later once the socket is in use, as the end result
of either is effectively the same.

6 months agoDon't wait during selftest process cleanup
Jeremy Stanley [Sat, 17 Apr 2021 16:05:03 +0000 (16:05 +0000)]
Don't wait during selftest process cleanup

Remove an unconditional one-second delay after executing kill during
process cleanup. Subsequent torture tests indicate this was likely
unnecessary, but it slowed down testing considerably.

6 months agoDon't leave dangling file descriptor in selftest
Jeremy Stanley [Sat, 17 Apr 2021 15:59:18 +0000 (15:59 +0000)]
Don't leave dangling file descriptor in selftest

Use context management when opening the configuration file in
selftests so that its file descriptor will be cleaned up as soon as
loading completes.

6 months agoMake dist checking directory-agnostic
Jeremy Stanley [Sat, 17 Apr 2021 15:47:18 +0000 (15:47 +0000)]
Make dist checking directory-agnostic

Use the toxindir replacement macro in tox.ini to properly anchor the
base directory for dist building and checking. This ensures it will
run successfully even if the current working directory is not the
top level directory of the source tree.

6 months agoGet more granular with Python warnings in tests
Jeremy Stanley [Sat, 17 Apr 2021 15:44:36 +0000 (15:44 +0000)]
Get more granular with Python warnings in tests

Apparently, the PYTHONWARNINGS envvar has a rather flexible grammar
which can do things like exclude specific modules. Take advantage of
this to temporarily whitelist persistent problems in dependencies
(particularly packaging ecosystem tools/libraries) until they're
solved by their respective upstreams.

6 months agoUse consistent spacing in tox variables and lists
Jeremy Stanley [Sat, 17 Apr 2021 15:42:21 +0000 (15:42 +0000)]
Use consistent spacing in tox variables and lists

Tox is fine with spaces between list elements and variable
assignment operators. We used more readable spacing in some parts of
tox.ini, so make the rest of the file consistent.

6 months agoStop setting a default install command for tox
Jeremy Stanley [Sat, 17 Apr 2021 15:38:47 +0000 (15:38 +0000)]
Stop setting a default install command for tox

The install command we've been setting for tox is effectively
equivalent to its internal default. Just drop it.

6 months agoDon't check spelling in data directory
Jeremy Stanley [Sat, 17 Apr 2021 15:34:30 +0000 (15:34 +0000)]
Don't check spelling in data directory

The selftest can write some fairly random strings into ephemeral
files in the data directory, which get left behind and might trigger
false positives for codespell. None of what appears in this
directory is committed into source control, so we really don't care.
Just skip checking it.

7 months agoLint autogenerated YAML
Jeremy Stanley [Sat, 6 Mar 2021 02:38:00 +0000 (02:38 +0000)]
Lint autogenerated YAML

Run the selftest before calling yamllint, so that we can confirm the
YAML files generated by the data module follow the same format as
those shipped in the repository.

7 months agoUse twine's strict mode
Jeremy Stanley [Sat, 6 Mar 2021 02:34:40 +0000 (02:34 +0000)]
Use twine's strict mode

Twine has added a --strict option, and for now it succeeds testing
our build artifacts, so start using it.

7 months agoStop trying to use PYTHONWARNINGS=error for now
Jeremy Stanley [Sat, 6 Mar 2021 02:28:42 +0000 (02:28 +0000)]
Stop trying to use PYTHONWARNINGS=error for now

Additional deprecations in Setuptools have made trying to treat them
as errors basically insurmountable, and will likely remain that way
in some of the older Python interpreters we still support. Update
the comments in tox.ini in an attempt to track the latest blockers.

7 months agoAdd descriptions to tox testenvs
Jeremy Stanley [Sat, 6 Mar 2021 02:18:42 +0000 (02:18 +0000)]
Add descriptions to tox testenvs

Include a one-line description for each testenv in the tox.ini file,
useful for generally documenting what they're for, and displayed by
the `tox -lv` command.

7 months agoStop using the tox-venv plugin
Jeremy Stanley [Sat, 6 Mar 2021 02:05:50 +0000 (02:05 +0000)]
Stop using the tox-venv plugin

The tox-venv plugin is deprecated, now that tox can call the venv
module directly in place of virtualenv. Drop it, stop recommending
it in the documentation, and configure tox to use venv explicitly

7 months agoCorrect package metadata
Jeremy Stanley [Mon, 22 Feb 2021 07:43:12 +0000 (07:43 +0000)]
Correct package metadata

The platforms and classifiers parameters in setup.cfg are supposed
to be plural, their singular forms are deprecated. Update them

8 months agoBind to loopback interface by default
Jeremy Stanley [Sat, 30 Jan 2021 01:06:16 +0000 (01:06 +0000)]
Bind to loopback interface by default

Adjust the fallback behavior for otherwise unconfigured address
binding to match the safe posture adopted in the sample

10 months agoUse released codespell
Jeremy Stanley [Thu, 3 Dec 2020 19:31:58 +0000 (19:31 +0000)]
Use released codespell

Now that codespell has cut a release supporting in-repo
configuration, simplify our tox testenv for it accordingly. Also
update the status on the deprecation warnings situation, as the
latest blockers now lie with Setuptools rather than PBR.

11 months agoSwitch the selftest dialogue to a normal dict
Jeremy Stanley [Sun, 1 Nov 2020 16:52:07 +0000 (16:52 +0000)]
Switch the selftest dialogue to a normal dict

Starting with Python 3.6, dicts are implicitly ordered (albeit as a
side effect in 3.6, 3.7 is consistent with 3.6 and guarantees
ordering in interpreter versions from that point on). We no longer
need to use collections.OrderedDict for the selftest dialogue as a
result, so use a regular dict there now to simplify it.

11 months agoUse PosixPath arguments with os.remove()
Jeremy Stanley [Sun, 1 Nov 2020 16:48:25 +0000 (16:48 +0000)]
Use PosixPath arguments with os.remove()

Starting with Python 3.6, it's possible to pass a PosixPath to the
os.remove function instead of having to use the .name attribute.

11 months agoAlways use ModuleNotFoundError
Jeremy Stanley [Sun, 1 Nov 2020 16:46:44 +0000 (16:46 +0000)]
Always use ModuleNotFoundError

Now that we no longer support Python 3.5, we can assume
ModuleNotFoundError is always available and drop our
backward-compatible workaround for it in

11 months agoDrop support for Python 3.5
Jeremy Stanley [Sun, 1 Nov 2020 16:10:17 +0000 (16:10 +0000)]
Drop support for Python 3.5

It's been a couple of months since Python 3.5 officially reached end
of life, so stop advertising support in preparation for beginning to
use features only available in Python 3.6 and later.

12 months agoMove debug warning from setup to load
Jeremy Stanley [Fri, 9 Oct 2020 16:55:20 +0000 (16:55 +0000)]
Move debug warning from setup to load

Relocate the warning logged about debug mode from the misc.setup()
function to the Universe class load() method. This way, if debug
mode is enabled in configuration during a live reload event, it will
be logged. Also update the admin documentation to reflect that
enabling or disabling debug can be done with a reload, not only a
restart. Correct a minor spacing error in the configuration docs

12 months agoIncorporate pending logs from load during reloads
Jeremy Stanley [Fri, 9 Oct 2020 16:42:04 +0000 (16:42 +0000)]
Incorporate pending logs from load during reloads

The load() method for Universe class objects accumulates potential
log entries because it can be called when logging hasn't been set up
yet (for example, early at service start). When called during a
reload, these messages were previously discarded. Instead, add them
to the loglines attribute of the new universe so they will get
properly logged.

12 months agoReorder loglines fields
Jeremy Stanley [Fri, 9 Oct 2020 16:35:46 +0000 (16:35 +0000)]
Reorder loglines fields

Switch the Universe.loglines attribute's structure to place the log
message first and the log level value second, so that it's
consistent with the order in which those parameters are supplied by
the misc.log() function. While we're adjusting this in the
misc.get_loglines() function, switch the output construction from
concatenation to format strings for improved manageability.

12 months agoRecast is_restricted() to a bool 0.3.0
Jeremy Stanley [Wed, 7 Oct 2020 15:54:20 +0000 (15:54 +0000)]
Recast is_restricted() to a bool

When returning from the is_restricted function, just coerce the
lookups to a boolean type rather than forcing False defaults for
each facet.

12 months agoThe del and return statements aren't functions
Jeremy Stanley [Wed, 7 Oct 2020 15:51:01 +0000 (15:51 +0000)]
The del and return statements aren't functions

Correct a number of uses of del and return which had superfluous
parentheses. These are statement keywords, not function names, so
don't require parentheses around their expressions.

12 months agoSupport Python 3.10
Jeremy Stanley [Wed, 7 Oct 2020 15:34:02 +0000 (15:34 +0000)]
Support Python 3.10

Update the package's trove metadata to indicate support for Python
3.10 now that 3.10.0a1 has been tagged.

12 months agoDon't fail dist or docs builds on deprecations
Jeremy Stanley [Wed, 7 Oct 2020 15:27:33 +0000 (15:27 +0000)]
Don't fail dist or docs builds on deprecations

The current deprecation issues in dependencies raise warnings for
the dist and docs tox environments when run with Python 3.9 as the
default python3 interpreter. Use the same exclusions in the base
testenv definition for them now, until the maintainers of those
dependencies release updates.

12 months agoReplace show result with debug evaluate command
Jeremy Stanley [Sat, 3 Oct 2020 20:16:02 +0000 (20:16 +0000)]
Replace show result with debug evaluate command

The show result subcommand was quite unsafe. Even though it limited
the globals for strings passed to the env() builtin, it was still
possible for admins to do things like call the exec() builtin and
then import other modules, or use open() to overwrite files
writeable by the user under which the engine was running.

Introduce a new evaluate command as a substitute and remove the show
result subcommand. Use the debugging framework to limit access to
evaluate so that it's only available if debug mode is enabled in the
configuration at the time the daemon is started. Further limit
evaluate to not have most of the normal builtins, and explicitly
reject any strings containing a double-underscore (__) so that base
attributes of other modules such as __builtins__ can't be called
into easily, or "lambda" so that lambda functions can't be used to
work around protections. Also add some selftests to make sure
evaluate can still use the expressions we previously tested with
show result, and that only administrators can use it, and that it's
only available to them when debug mode is enabled.

The evaluate command is still to be considered quite unsafe, and
debug mode should only be engaged when all administrators with
access to the service are trusted with the same permissions the
system account running the service also possesses.

12 months agoRun different selftests when debug mode is engaged
Jeremy Stanley [Sat, 3 Oct 2020 19:04:58 +0000 (19:04 +0000)]
Run different selftests when debug mode is engaged

Add two skiplist tuples to the selftest framework, one for tests to
remove when debug mode is on, another for tests to remove when debug
mode is off. This is not used yet, so the tuples are initially
empty. Also enable debug mode in the daemon config fixture so that
debug functionality can be tested in the normal selftest run. The
default example config (tested with tox -e selftest_config) covers
the debug disabled case.

12 months agoAdd warnings about debugging mode
Jeremy Stanley [Sun, 4 Oct 2020 15:11:58 +0000 (15:11 +0000)]
Add warnings about debugging mode

Debugging mode is intended to enable administrative commands which
are especially unsafe and could even be used to run arbitrary shell
commands or alter files accessible to the user under which the
service runs. Log a warning about it at startup if the option has
been set, and insert some comments to that effect in the sample
configuration so that hopefully no one will turn it on without due
forethought. Also add a mention about its risks in the config doc.

12 months agoAdd restricted debug mode
Jeremy Stanley [Sat, 3 Oct 2020 18:09:10 +0000 (18:09 +0000)]
Add restricted debug mode

Create a new configuration flag, .mudpy.limit.debug, which indicates
unsafe debugging options will be available in the running engine.
This is unused, but lays the groundwork for future unsafe commands
to be toggled at start in base configuration.

12 months agoMake selftest dialogue mutable
Jeremy Stanley [Sat, 3 Oct 2020 17:45:47 +0000 (17:45 +0000)]
Make selftest dialogue mutable

In order to support future selectivity of test sets, replace the
immutable tuple of all tests with a dict keyed by test object.
Iterate over a copy of it so that the original is not altered when
tests are eventually removed during runtime. For Python 3.5 and
earlier, use OrderedDict so that test order is explicitly preserved.

12 months agoSkip spellcheck on logfiles
Jeremy Stanley [Sat, 3 Oct 2020 17:32:56 +0000 (17:32 +0000)]
Skip spellcheck on logfiles

Add any filenames ending with .log to the skiplist for codespell

12 months agoAdd is_restricted boolean check for commands
Jeremy Stanley [Fri, 2 Oct 2020 19:59:45 +0000 (19:59 +0000)]
Add is_restricted boolean check for commands

In preparation for adding additional command restriction indicators,
add a simple Element class method to return whether a command
element is flagged as administrative.

12 months agoAdd is_admin method to Element and User classes
Jeremy Stanley [Wed, 30 Sep 2020 19:57:13 +0000 (19:57 +0000)]
Add is_admin method to Element and User classes

For clarity and convenience, create an is_admin() boolean check for
whether a User's account or an actor Element's owner's account is
flagged as an administrator. Put them to use in places where the
administrator facet was previously checked directly. This allows us
to do a little additional safety checking to avoid hitting corner
cases where we try to check some object which may or may not have an

12 months agoStreamline can_run access control method
Jeremy Stanley [Wed, 30 Sep 2020 18:07:46 +0000 (18:07 +0000)]
Streamline can_run access control method

Minor rework of can_run() to replace the chain of elifs with simple
short-circuiting conditions each with its own return() so that it's
clearer this operates in a "first match" model.

12 months agoCheck for warnings in the to dist env 0.2.1
Jeremy Stanley [Sat, 19 Sep 2020 14:34:43 +0000 (14:34 +0000)]
Check for warnings in the to dist env

Some deprecated Setuptools operations were removed in a recent PBR
release, allowing us to now build sdist and wheel artifacts with
warnings as errors. There are still a couple more outstanding
deprecation fixes needed for other envs, so update the comment in
tox.ini accordingly.

12 months agoExplicitly close files opened by selftest
Jeremy Stanley [Sat, 19 Sep 2020 14:32:11 +0000 (14:32 +0000)]
Explicitly close files opened by selftest

Newer Python interpreters emit a warning during cleanup if open
files are not closed prior to termination. Our selftest opens the
pidfile for reading in a couple of places, as well as logfiles to
capture stdout/stderr. Open them in context blocks so they will be
closed on return rather than remaining open until the process ends.

12 months agoHandle early wrapping in test_show_result
Jeremy Stanley [Sat, 19 Sep 2020 14:29:59 +0000 (14:29 +0000)]
Handle early wrapping in test_show_result

When showing a Python module object, the included file path can
easily be long enough to wrap to the next line. Allow for line
breaks immediately before it in the test_show_result test where it
sometimes surfaces.

12 months agoDrop redundant master_doc setting from Sphinx conf
Jeremy Stanley [Sat, 19 Sep 2020 14:28:11 +0000 (14:28 +0000)]
Drop redundant master_doc setting from Sphinx conf

The master_doc option to Sphinx already defaults to looking for a
document named "index" so it's unnecessary to set explicitly in our
case. Clean it up.

13 months agoSwitch tox to use allowlist_externals
Jeremy Stanley [Wed, 16 Sep 2020 22:38:28 +0000 (22:38 +0000)]
Switch tox to use allowlist_externals

The whitelist_externals option in tox in deprecated in favor of
allowlist_externals. Update this and also bump our tox minversion to
the earliest version which supports this new syntax. While we're at
it, update a few code comments about bandit "nosec" exceptions to
refer to allowing instead of whitelisting.

13 months agoStart checking codebase with the codespell tool
Jeremy Stanley [Wed, 16 Sep 2020 22:24:02 +0000 (22:24 +0000)]
Start checking codebase with the codespell tool

Use master branch tip of codespell for now, until it supports
configuration in the included .codespellrc in a released version.
Also correct things its default dictionary selection identified as
misspellings, with the exception of intentional misspellings in the
sample spelling correction config and selftest which exercises it.

13 months agoRevert "No longer run in docs builds" 0.2.0
Jeremy Stanley [Sun, 23 Aug 2020 21:38:37 +0000 (21:38 +0000)]
Revert "No longer run in docs builds"

Turns out, PBR won't generate the ChangeLog without an explicit
install/build after all, or at least not in the way which tox is
handling it. This slipped through testing due to not running in a
clean tree.

This reverts commit 70381626690da47866363ef51ef8a37a4831dffa.

13 months agoRatchet down Python warnings in tox
Jeremy Stanley [Sun, 23 Aug 2020 21:14:43 +0000 (21:14 +0000)]
Ratchet down Python warnings in tox

Where possible, have tox envs treat any Python warning as an error.
This is not currently possible for any envs which invoke certain PBR
functionality, since it has a couple of outstanding fixes under
review to make it cease calling into deprecated code on newer Python
releases. Eventually this should be set in the global testenv when
possible, and only rolled back in case of dependency regressions or
new errors introduced by future interpreter versions.

14 months agoNo longer run in docs builds
Jeremy Stanley [Wed, 12 Aug 2020 09:56:24 +0000 (09:56 +0000)]
No longer run in docs builds

Since we don't skip sdist generation for our documentation builds in
tox, the separate install step is unnecessary as PBR will
already generate a current ChangeLog when the sdist is built.

14 months agoSet python_requires
Jeremy Stanley [Mon, 3 Aug 2020 10:35:10 +0000 (10:35 +0000)]
Set python_requires

Newer versions of pip will check PyPI for python_requires metadata,
helping to determine prior to package download if the local version
of the interpreter is sufficiently new to support a given package
version. Set ours to >= 3.5 for now. This should be increased any
time support for an old interpreter release is dropped from the list
in our trove classifiers.

15 months agoCorrect package metadata
Jeremy Stanley [Tue, 7 Jul 2020 10:50:19 +0000 (10:50 +0000)]
Correct package metadata

Use the more correct metadata fields recognized by
Setuptools/distutils rather in lieu of some used only by PBR.

16 months agoReport if service does not start under selftest
Jeremy Stanley [Tue, 2 Jun 2020 23:12:45 +0000 (23:12 +0000)]
Report if service does not start under selftest

Output a useful error and stop the selftest script immediately if
the service it tries to start does not actually start, to make
debugging some classes of errors slightly faster.

16 months agoPrefer importlib over pkg_resources
Jeremy Stanley [Sat, 23 May 2020 20:11:18 +0000 (20:11 +0000)]
Prefer importlib over pkg_resources

Since Setuptools pkg_resources library is effectively deprecated in
newer releases, try to use the equivalent importlib.metadata
features and exceptions when they're available.

17 months agoRecord the reported rows from NAWS negotiation
Jeremy Stanley [Wed, 22 Apr 2020 19:54:54 +0000 (19:54 +0000)]
Record the reported rows from NAWS negotiation

In preparation for future pagination support, get the rows included
in NAWS responses and record that as an integer in the User.rows
attribute, similar to the existing User.columns value used for line

18 months agoObtain terminal type (RFC 1091)
Jeremy Stanley [Sun, 12 Apr 2020 20:17:57 +0000 (20:17 +0000)]
Obtain terminal type (RFC 1091)

Implement rudimentary support for determining the terminal type
reported by RFC 1091 TTYPE compatible clients, and store any initial
value returned in the User.ttype attribute. This implementation does
not iterate over SEND TTYPE commands until UNKNOWN is returned, it
only takes the first value returned and assumes this is the default
terminal type for the user's current connection.

18 months agoOverhaul coder guide, add commands and misc
Jeremy Stanley [Sat, 21 Mar 2020 03:25:14 +0000 (03:25 +0000)]
Overhaul coder guide, add commands and misc

Brush up the quality of the coder guide, using relevant autodoc
references and clearer markup, as well as improving some wording.
Add a section on custom commands, and another for miscellaneous
design discussions taken from various recent E-mail threads.

20 months agoStart the install guide
Jeremy Stanley [Fri, 7 Feb 2020 08:12:17 +0000 (08:12 +0000)]
Start the install guide

Create a stub document with some installation and configuration
tips, to be expanded into something more useful over time.

21 months agoAdd the beginnings of an admin guide
Jeremy Stanley [Sun, 12 Jan 2020 08:04:54 +0000 (08:04 +0000)]
Add the beginnings of an admin guide

Some initial prose to seed the admin guide, taken from various
E-mails to users in recent months.

21 months agoCollapse redundant exceptions
Jeremy Stanley [Wed, 8 Jan 2020 23:29:54 +0000 (23:29 +0000)]
Collapse redundant exceptions

In User.enqueue_input() combine a redundant match on BlockingIOError
and OSError since the former is a subclass of the latter. This was
caught by the B014 check introduced in flake8-bugbear 20.1.1.

21 months agoIndicate support for Python 3.9
Jeremy Stanley [Tue, 7 Jan 2020 00:45:35 +0000 (00:45 +0000)]
Indicate support for Python 3.9

Python 3.9 is well into its second alpha, is a recognized trove
classifier on PyPI, and all mudpy changes are being successfully
tested against it. Add the classifier to our package metadata to
reflect this.

21 months agoLink the ChangeLog from package metadata
Jeremy Stanley [Tue, 7 Jan 2020 00:43:14 +0000 (00:43 +0000)]
Link the ChangeLog from package metadata

Users of PyPI are going to want to know where to find the ChangeLog
without going to the project homepage/docs and hunting around. Add a
flexible redirect URL for it so we can move it easily later.

21 months agoDrop section numbering from documentation builds
Jeremy Stanley [Tue, 7 Jan 2020 00:38:14 +0000 (00:38 +0000)]
Drop section numbering from documentation builds

Sphinx section numbering leads to confusing output, particularly for
the rendered ChangeLog. Remove it.

Update copyright year in the LICENSE as this is the first change of
the new year, and similarly update it in rendered documentation
footers as this is the first documentation change of the year.

21 months agoMake sure all command functions return True 0.1.1
Jeremy Stanley [Mon, 30 Dec 2019 17:52:01 +0000 (17:52 +0000)]
Make sure all command functions return True

Because recent adjustments to handler_active() rely on the
call_handler_function() return value to determine whether something
went wrong, we need command functions to return something which
evaluates boolean True if they ran to completion and didn't raise an
exception. Just return True from all of them for now, but they may
see more dynamic result handling in the future.

21 months agoIncrease timer resolution in test config 0.1.0
Jeremy Stanley [Mon, 30 Dec 2019 15:41:34 +0000 (15:41 +0000)]
Increase timer resolution in test config

Significantly speed up the timer in the test config (by a factor of
1000). On fast machines with cached tox envs, this results in an
order of magnitude improvement in test runtime. Related timer values
are lengthened to avoid test failures due to timeouts, and some
others are shortened for consistency.

This is obviously not suitable for normal operation, so the sample
configuration remains untouched and thus the tox selftest_config
testenv does not benefit from it.

21 months agoUse call_hook_function() in handler_active()
Jeremy Stanley [Mon, 30 Dec 2019 15:18:52 +0000 (15:18 +0000)]
Use call_hook_function() in handler_active()

Simplify mudpy.misc.handler_active() by making it a wrapper around
the more general mudpy.misc.call_hook_function() which was
originally derived from it.

21 months agoPreserve loglines on reload
Jeremy Stanley [Mon, 30 Dec 2019 01:49:32 +0000 (01:49 +0000)]
Preserve loglines on reload

When a reload occurs, prepend the new universe's loglines with those
from the old universe so they are not lost. This may temporarily
bloat the loglines list slightly over the limit, but it will be
adjusted downward the next time anything new gets logged. Also
adjust the `show log` selftests to handle linewraps in a new place
when the total loglines count is higher.

21 months agoSet bandit to error on risks of any severity
Jeremy Stanley [Sun, 29 Dec 2019 14:25:17 +0000 (14:25 +0000)]
Set bandit to error on risks of any severity

Now that the last of the low-level risks has been reviewed and
whitelisted, remove the severity filter from the bandit command so
that incorporation of any unexpected risks it can spot will be
blocked for future commits.

21 months agoWhitelist uses of stdlib random module for bandit
Jeremy Stanley [Sun, 29 Dec 2019 14:19:57 +0000 (14:19 +0000)]
Whitelist uses of stdlib random module for bandit

There are currently two uses of random.randrange() and one of
random.choice() for non-security/non-crypto purposes. Mark them as
whitelisted for bandit checks and add comments explaining why.

21 months agoClean up function names in menu definitions
Jeremy Stanley [Sun, 29 Dec 2019 12:31:36 +0000 (12:31 +0000)]
Clean up function names in menu definitions

Now that the functions called from menus are filtered and resolved
safely rather than being directly executed, the explicit mudpy
package name and the user parameter passing are no longer necessary.
Remove them from the function names in menu definitions and also
drop the old compatibility code which trims them.

21 months agoRatchet bandit checking down to medium severity
Jeremy Stanley [Sun, 29 Dec 2019 12:23:44 +0000 (12:23 +0000)]
Ratchet bandit checking down to medium severity

Now that the last of the medium-severity risks have been eliminated,
adjust the bandit command line so that it will prevent addition of
any new instances.

21 months agoReplace eval() and exec() use for menu functions
Jeremy Stanley [Sat, 28 Dec 2019 21:01:32 +0000 (21:01 +0000)]
Replace eval() and exec() use for menu functions

Add a new misc.call_hook_function() routine based on the existing
command execution in misc.handler_active() to eliminate all use of
eval() and exec() built-ins in menu operations.

21 months agoRelocate main_utility menu functions
Jeremy Stanley [Thu, 26 Dec 2019 02:45:25 +0000 (02:45 +0000)]
Relocate main_utility menu functions

Move the action and demand logic for the main_utility state from
their respective facets to the menu module, hiding them behind
consistently-named entry points.

21 months agoRelocate delete_avatar menu functions
Jeremy Stanley [Wed, 25 Dec 2019 22:49:48 +0000 (22:49 +0000)]
Relocate delete_avatar menu functions

Move the action and create logic for the delete_avatar state from
their respective facets to the menu module, hiding them behind
consistently-named entry points.

21 months agoRelocate delete_account menu function
Jeremy Stanley [Wed, 25 Dec 2019 22:23:08 +0000 (22:23 +0000)]
Relocate delete_account menu function

Move the action logic for the delete_account state from its
corresponding facet to the menu module, hiding it behind a
consistently-named entry point.

21 months agoRelocate choose_name menu functions
Jeremy Stanley [Wed, 25 Dec 2019 22:13:16 +0000 (22:13 +0000)]
Relocate choose_name menu functions

Move the action and create logic for the choose_name state from
their respective facets to the menu module, hiding them behind
consistently-named entry points.

21 months agoRelocate choose_gender menu function
Jeremy Stanley [Wed, 25 Dec 2019 21:52:02 +0000 (21:52 +0000)]
Relocate choose_gender menu function

Move the action logic for the choose_gender state from its
corresponding facet to the menu module, hiding it behind a
consistently-named entry point.

21 months agoRelocate checking_new_account_name menu functions
Jeremy Stanley [Wed, 25 Dec 2019 21:45:45 +0000 (21:45 +0000)]
Relocate checking_new_account_name menu functions

Move the action logic for the checking_new_account_name state from
its respective facets to the menu module, hiding them behind
consistently-named entry points.

21 months agoRelocate activate_avatar menu functions
Jeremy Stanley [Wed, 25 Dec 2019 20:02:41 +0000 (20:02 +0000)]
Relocate activate_avatar menu functions

Move the action and create logic for the activate_avatar state from
their respective facets to the menu module, hiding them behind
consistently-named entry points.

21 months agoAdd a module to hold menu functions
Jeremy Stanley [Tue, 24 Dec 2019 22:55:01 +0000 (22:55 +0000)]
Add a module to hold menu functions

In preparation for relocating arbitrary Python expressions out of
the standard menu elements, provide a stub module which
will house equivalent convenience functions and include an autodoc
section for it in the Sphinx API documentation template.

21 months agoMove selected menu item into the User object
Jeremy Stanley [Wed, 25 Dec 2019 21:24:06 +0000 (21:24 +0000)]
Move selected menu item into the User object

In order to simplify menu handlers, move the active choice into an
attribute of the User class so that only one object needs to be
handed off, and update menus accordingly.

21 months agoRename state variable in get_menu_choices()
Jeremy Stanley [Wed, 25 Dec 2019 13:12:43 +0000 (13:12 +0000)]
Rename state variable in get_menu_choices()

Avoid shadowing the new menu module in misc.get_menu_choices() by
renaming its menu variable to state, which is also more consistent
with other menu-related functions.

21 months agoRemove exec() from handle_user_input() function
Jeremy Stanley [Tue, 24 Dec 2019 22:37:18 +0000 (22:37 +0000)]
Remove exec() from handle_user_input() function

Stop passing the constructed handler function name into an exec()
and instead reference it from the globals() dict.

21 months agoEliminate exec() in
Jeremy Stanley [Tue, 24 Dec 2019 22:23:32 +0000 (22:23 +0000)]
Eliminate exec() in

Replace questionable exec call in the new() method of the Universe
class with cleaner getattr/setattr equivalents.

21 months agoMore thoroughly test account and avatar menus
Jeremy Stanley [Thu, 26 Dec 2019 01:57:24 +0000 (01:57 +0000)]
More thoroughly test account and avatar menus

Split up the teardown "test" into separate tests for avatar and
account deletion. Avatar deletion was previously not being exercised
correctly, instead avatar deletion aborting was what was actually
being tested. Add separate tests that the avatar and account
deletion default actions are to abort. Also add a test of the avatar
creation limit.

21 months agoProperly escape punctuation in test patterns
Jeremy Stanley [Wed, 25 Dec 2019 23:04:20 +0000 (23:04 +0000)]
Properly escape punctuation in test patterns

Make sure all literal question marks (?) and periods (.) in selftest
match patterns are backslash-escaped in raw strings.

21 months agoTighten up eval() scope in show result subcommand
Jeremy Stanley [Tue, 24 Dec 2019 21:33:37 +0000 (21:33 +0000)]
Tighten up eval() scope in show result subcommand

In order to slightly reduce risk but mostly to increase convenience
with the `show result` administrative subcommand, replace its eval()
invocation's globals with just the mudpy module namespace and the
actor's universe pointer as "universe" (this way exploratory
expressions don't need to do things relative to actor.universe all
the time). Extend the selftest to confirm these are present and that
any attempts to access other globals and locals within the function's scope raise an exception.

Whitelist this intentional use of eval() for bandit analysis.

21 months agoReplace uses of exec() in module loader
Jeremy Stanley [Sun, 22 Dec 2019 20:48:12 +0000 (20:48 +0000)]
Replace uses of exec() in module loader

Improve the module loader to avoid the more dangerous exec()
function in favor of smarter use of importlib. This allows us to
drop some flake8 whitelisting. Also switch out the hard-coded module
list (which missed addition of the daemon module) with a more
dynamic routine on Python 3.7 and later, which will use all *.py
files in the top level of the package so none are forgotten in the
future. Keep a hard-coded fallback list for support of earlier
Python versions, but compare the two so this list is guaranteed
complete for as long as it is maintained.

23 months agoUse generic authors for copyright shown in docs
Jeremy Stanley [Tue, 12 Nov 2019 15:25:59 +0000 (15:25 +0000)]
Use generic authors for copyright shown in docs

Adjust the copyright holder listed in the Sphinx-built documentation
to match the more general "mudpy authors" used in copyright headers
for files.

2 years agoUpdate copyright for files edited in 2019
Jeremy Stanley [Thu, 17 Oct 2019 07:21:36 +0000 (07:21 +0000)]
Update copyright for files edited in 2019

These files missed a copyright year bump when they were edited.

2 years agoSatisfy yamllint checking of .yamllint
Jeremy Stanley [Wed, 16 Oct 2019 11:11:43 +0000 (11:11 +0000)]
Satisfy yamllint checking of .yamllint

The 1.18.0 release of yamllint has started linting its .yamllint
config file by default. Add a document marker at the top of the file
so that it will pass document-start rule.

2 years agoLog User object ID even when account is an admin 0.0.2
Jeremy Stanley [Fri, 27 Sep 2019 16:26:54 +0000 (16:26 +0000)]
Log User object ID even when account is an admin

Adjust authentication logging to consistently record the User object
instance ID regardless of, and separately from, whether the account
which authenticated is an administrator.

2 years agoLog starting directory during initialization
Jeremy Stanley [Sun, 1 Sep 2019 21:35:00 +0000 (21:35 +0000)]
Log starting directory during initialization

Update the initialization logging to also include the starting
directory, since some of the startup routines form their file paths
relative to it.

2 years agoSeparate listening port in startup logging
Jeremy Stanley [Sat, 24 Aug 2019 19:32:33 +0000 (19:32 +0000)]
Separate listening port in startup logging

Using a port separator of ":" is vague in combination with IPv6
addresses, so separate the listening port number more clearly in the
startup log message.

2 years agoDisable usedevelop for some tox testenvs
Jeremy Stanley [Wed, 10 Jul 2019 17:18:53 +0000 (17:18 +0000)]
Disable usedevelop for some tox testenvs

Tox's usedevelop option implicitly installs the project and its
dependencies, and is enabled in the base testenv. Disable it in
testenvs which don't make use of the installed project, but add the
project dependencies to the docs testenv since it needs them to be
able to generate the API docs. This results in a fairly substantial
speedup of >10% for a full `tox` invocation.

2 years agoCorrect reference to main config in walk-through
Jeremy Stanley [Sun, 7 Jul 2019 11:36:22 +0000 (11:36 +0000)]
Correct reference to main config in walk-through

The main sample configuration is mudpy.yaml, not mudpy.conf.

2 years agoAdd info on what's missing and included 0.0.1
Jeremy Stanley [Sun, 7 Jul 2019 03:06:15 +0000 (03:06 +0000)]
Add info on what's missing and included

To properly set expectations, update the README file with
information on the current state of development, what's done so far
and what's not yet.

2 years agoAdd a demo walk-through to the coder guide
Jeremy Stanley [Sun, 7 Jul 2019 01:49:28 +0000 (01:49 +0000)]
Add a demo walk-through to the coder guide

Include an example of a simple development environment setup,
explaining how to start the server using the provided sample
configuration and then interact with it using a console-based MUD

2 years agoRecommend the tox-venv plug-in
Jeremy Stanley [Sun, 7 Jul 2019 01:45:47 +0000 (01:45 +0000)]
Recommend the tox-venv plug-in

In the coder guide, include a suggestion for tox-venv (a tox plug-in
which makes tox use the venv module from the Python 3 standard
library in place of the separate virtualenv package).

2 years agoLink API documentation in the coder guide
Jeremy Stanley [Sun, 7 Jul 2019 01:42:20 +0000 (01:42 +0000)]
Link API documentation in the coder guide

In the API section of the coder guide, add a cross-link to the API
documentation for the package and modules.

2 years agoDrop Python 3.4 and add 3.8
Jeremy Stanley [Sat, 6 Jul 2019 22:13:00 +0000 (22:13 +0000)]
Drop Python 3.4 and add 3.8

Python 3.4 reached end-of-life status nearly 4 months ago with the
release of 3.4.10 on 2019-03-18, so stop asserting we test new
commits against it (truth be told, it was already hard to build on
modern distros with newer libssl anyway).

Python 3.8 has been in beta for over a month already, and 3.8.0b2
was tagged earlier this week. New commits have been tested against
3.8 alpha and beta builds for a while, so add it to the list of
trove classifiers.

Update the README file to stop mentioning minimum Python 3 versions,
so that it won't need further updates as older interpreters age out.

2 years agoUpdate minimum PBR for setup_requires
Jeremy Stanley [Mon, 10 Jun 2019 22:49:15 +0000 (22:49 +0000)]
Update minimum PBR for setup_requires

Some of the recently-added Python package metadata (particularly
project_urls and description-content-type) need newer PBR where that
support was added. PBR 5.0.0 is the oldest version with the
particular features we're using, so update the lower bound for it

2 years agoImprove preferences display
Jeremy Stanley [Mon, 13 May 2019 20:26:09 +0000 (20:26 +0000)]
Improve preferences display

When displaying preferences, color-code the base and admin
preferences similar to command help. Also show a placeholder when
there is no existing value set for a preference. Add a hyphen
separator between preference names and values. Update tests to
accommodate the new formatting, and while we're there add a test to
make sure non-admins can't set values for admin-only preferences.