269 lines
9.1 KiB
Python
269 lines
9.1 KiB
Python
"""
|
|
This defines some test commands for use while testing the MUD and its components.
|
|
|
|
"""
|
|
|
|
from django.conf import settings
|
|
from django.db import IntegrityError
|
|
from src.comms.models import Msg
|
|
from src.permissions import permissions
|
|
from src.utils import create
|
|
from src.utils import debug
|
|
from game.gamesrc.commands.default.muxcommand import MuxCommand
|
|
|
|
from src.commands import cmdsethandler
|
|
|
|
|
|
# Test permissions
|
|
|
|
class CmdTest(MuxCommand):
|
|
"""
|
|
test the command system
|
|
|
|
Usage:
|
|
@test <any argument or switch>
|
|
|
|
This command will echo back all argument or switches
|
|
given to it, showcasing the muxcommand style.
|
|
"""
|
|
|
|
key = "@test"
|
|
aliases = ["@te", "@test all"]
|
|
#permissions = "cmd:Immortals Wizards"
|
|
|
|
# the muxcommand class itself handles the display
|
|
# so we just defer to it by not adding any function.
|
|
|
|
def func(self):
|
|
cmdsetname = "game.gamesrc.commands.default.cmdset_default.DefaultCmdSet"
|
|
self.caller.msg(cmdsethandler.CACHED_CMDSETS)
|
|
cmdsethandler.import_cmdset(cmdsetname, self, self)
|
|
self.caller.msg("Imported %s" % cmdsetname)
|
|
self.caller.msg(cmdsethandler.CACHED_CMDSETS)
|
|
|
|
|
|
|
|
|
|
class CmdTestPerms(MuxCommand):
|
|
"""
|
|
Test command - test permissions
|
|
|
|
Usage:
|
|
@testperm [[lockstring] [=permstring]]
|
|
|
|
With no arguments, runs a sequence of tests for the
|
|
permission system using the calling player's permissions.
|
|
|
|
If <lockstring> is given, match caller's permissions
|
|
against these locks. If also <permstring> is given,
|
|
match this against the given locks instead.
|
|
|
|
"""
|
|
key = "@testperm"
|
|
permissions = "cmd:Immortals Wizards"
|
|
|
|
def func(self):
|
|
"""
|
|
Run tests
|
|
"""
|
|
caller = self.caller
|
|
|
|
if caller.user.is_superuser:
|
|
caller.msg("You are a superuser. Permission tests are pointless.")
|
|
return
|
|
# create a test object
|
|
obj = create.create_object(None, "accessed_object") # this will use default typeclass
|
|
obj_id = obj.id
|
|
caller.msg("obj_attr: %s" % obj.attr("testattr"))
|
|
|
|
# perms = ["has_permission", "has permission", "skey:has_permission",
|
|
# "has_id(%s)" % obj_id, "has_attr(testattr)",
|
|
# "has_attr(testattr, testattr_value)"]
|
|
|
|
# test setting permissions
|
|
uprofile = caller.user.get_profile()
|
|
# do testing
|
|
caller.msg("----------------")
|
|
|
|
permissions.set_perm(obj, "has_permission")
|
|
permissions.add_perm(obj, "skey:has_permission")
|
|
caller.msg(" keys:[%s] locks:[%s]" % (uprofile.permissions, obj.permissions))
|
|
caller.msg("normal permtest: %s" % permissions.has_perm(uprofile, obj))
|
|
caller.msg("skey permtest: %s" % permissions.has_perm(uprofile, obj, 'skey'))
|
|
|
|
permissions.set_perm(uprofile, "has_permission")
|
|
caller.msg(" keys:[%s] locks:[%s]" % (uprofile.permissions, obj.permissions))
|
|
caller.msg("normal permtest: %s" % permissions.has_perm(uprofile, obj))
|
|
caller.msg("skey permtest: %s" % permissions.has_perm(uprofile, obj, 'skey'))
|
|
|
|
# function tests
|
|
permissions.set_perm(obj, "has_id(%s)" % (uprofile.id))
|
|
caller.msg(" keys:[%s] locks:[%s]" % (uprofile.permissions, obj.permissions))
|
|
caller.msg("functest: %s" % permissions.has_perm(uprofile, obj))
|
|
|
|
uprofile.attr("testattr", "testattr_value")
|
|
permissions.set_perm(obj, "has_attr(testattr, testattr_value)")
|
|
caller.msg(" keys:[%s] locks:[%s]" % (uprofile.permissions, obj.permissions))
|
|
caller.msg("functest: %s" % permissions.has_perm(uprofile, obj))
|
|
|
|
# cleanup of test permissions
|
|
permissions.del_perm(uprofile, "has_permission")
|
|
caller.msg(" cleanup: keys:[%s] locks:[%s]" % (uprofile.permissions, obj.permissions))
|
|
obj.delete()
|
|
uprofile.attr("testattr", delete=True)
|
|
|
|
|
|
# # Add/remove states (removed; not valid.)
|
|
|
|
# EXAMPLE_STATE="game.gamesrc.commands.examples.example.EXAMPLESTATE"
|
|
|
|
# class CmdTestState(MuxCommand):
|
|
# """
|
|
# Test command - add a state.
|
|
|
|
# Usage:
|
|
# @teststate[/switch] [<python path to state instance>]
|
|
# Switches:
|
|
# add - add a state
|
|
# clear - remove all added states.
|
|
# list - view current state stack
|
|
# reload - reload current state stack
|
|
|
|
# If no python path is given, an example state will be added.
|
|
# You will know it worked if you can use the commands '@testcommand'
|
|
# and 'smile'.
|
|
# """
|
|
|
|
# key = "@teststate"
|
|
# alias = "@testingstate"
|
|
# permissions = "cmd:Immortals Wizards"
|
|
|
|
# def func(self):
|
|
# """
|
|
# inp is the dict returned from MuxCommand's parser.
|
|
# """
|
|
# caller = self.caller
|
|
# switches = self.switches
|
|
|
|
# if not switches or switches[0] not in ["add", "clear", "list", "reload"]:
|
|
# string = "Usage: @teststate[/add|clear|list|reload] [<python path>]"
|
|
# caller.msg(string)
|
|
# elif "clear" in switches:
|
|
# caller.cmdset.clear()
|
|
# caller.msg("All cmdset cleared.")
|
|
# return
|
|
# elif "list" in switches:
|
|
# string = "%s" % caller.cmdset
|
|
# caller.msg(string)
|
|
# elif "reload" in switches:
|
|
# caller.cmdset.load()
|
|
# caller.msg("Cmdset reloaded.")
|
|
# else: #add
|
|
# arg = inp["raw"]
|
|
# if not arg:
|
|
# arg = EXAMPLE_STATE
|
|
# caller.cmdset.add(arg)
|
|
# string = "Added state '%s'." % caller.cmdset.state.key
|
|
# caller.msg(string)
|
|
|
|
class TestCom(MuxCommand):
|
|
"""
|
|
Test the command system
|
|
|
|
Usage:
|
|
@testcom/create/list [channel]
|
|
"""
|
|
key = "@testcom"
|
|
permissions = "cmd:Immortals Wizards"
|
|
|
|
def func(self):
|
|
"Run the test program"
|
|
caller = self.caller
|
|
|
|
if 'create' in self.switches:
|
|
if self.args:
|
|
chankey = self.args
|
|
try:
|
|
channel = create.create_channel(chankey)
|
|
except IntegrityError:
|
|
caller.msg("Channel '%s' already exists." % chankey)
|
|
return
|
|
channel.connect_to(caller)
|
|
caller.msg("Created new channel %s" % chankey)
|
|
msgobj = create.create_message(caller.player,
|
|
"First post to new channel!")
|
|
channel.msg(msgobj)
|
|
|
|
return
|
|
elif 'list' in self.switches:
|
|
msgresults = Msg.objects.get_messages_by_sender(caller)
|
|
string = "\n".join(["%s %s: %s" % (msg.date_sent,
|
|
[str(chan.key) for chan in msg.channels.all()],
|
|
msg.message)
|
|
for msg in msgresults])
|
|
caller.msg(string)
|
|
return
|
|
caller.msg("Usage: @testcom/create channel")
|
|
|
|
|
|
#TODO: make @debug more clever with arbitrary hooks?
|
|
class CmdDebug(MuxCommand):
|
|
"""
|
|
Debug game entities
|
|
|
|
Usage:
|
|
@debug[/switch] <path to code>
|
|
|
|
Switches:
|
|
obj - debug an object
|
|
script - debug a script
|
|
|
|
Examples:
|
|
@debug/script game.gamesrc.scripts.myscript.MyScript
|
|
@debug/script myscript.MyScript
|
|
@debug/obj examples.red_button.RedButton
|
|
|
|
This command helps when debugging the codes of objects and scripts.
|
|
It creates the given object and runs tests on its hooks. You can
|
|
supply both full paths (starting from the evennia base directory),
|
|
otherwise the system will start from the defined root directory
|
|
for scripts and objects respectively (defined in settings file).
|
|
|
|
"""
|
|
|
|
key = "@debug"
|
|
permissions = "cmd:debug"
|
|
help_category = "Building"
|
|
|
|
def func(self):
|
|
"Running the debug"
|
|
|
|
if not self.args or not self.switches:
|
|
self.caller.msg("Usage: @debug[/obj][/script] <path>")
|
|
return
|
|
|
|
path = self.args
|
|
|
|
if 'obj' in self.switches or 'object' in self.switches:
|
|
# analyze path. If it starts at the evennia basedir,
|
|
# (i.e. starts with game or src) we let it be, otherwise we
|
|
# add a base path as defined in settings
|
|
if path and not (path.startswith('src.') or
|
|
path.startswith('game.')):
|
|
path = "%s.%s" % (settings.BASE_TYPECLASS_PATH,
|
|
path)
|
|
|
|
# create and debug the object
|
|
self.caller.msg(debug.debug_object(path, self.caller))
|
|
self.caller.msg(debug.debug_object_scripts(path, self.caller))
|
|
|
|
elif 'script' in self.switches:
|
|
# analyze path. If it starts at the evennia basedir,
|
|
# (i.e. starts with game or src) we let it be, otherwise we
|
|
# add a base path as defined in settings
|
|
if path and not (path.startswith('src.') or
|
|
path.startswith('game.')):
|
|
path = "%s.%s" % (settings.BASE_SCRIPT_PATH,
|
|
path)
|
|
|
|
self.caller.msg(debug.debug_syntax_script(path))
|