Skip to main content

vim mock object for easier testing of vim plugins written in Python.

Project description

vimmock

https://secure.travis-ci.org/lukaszb/vimmock.png?branch=master

vimmock is a module that makes testing Python code using vim module much easier.

Usage

At the test environment initialization one should prepare vim object that would normaly be used within vim’s plugin. We have added convenient function for that:

import vimmock
vimmock.patch_vim()

This is equivalent to:

import sys
from vimmock import VimMock

sys.modules['vim'] = VimMock()

Once this is done one can start importing vim module which would be instance of VimMock class. From now on we can write our tests (and import vim module):

import vim
import unittest
import myplugin

class TestPlugin(unittest.TestCase):

    def setUp(self):
        vim.setup_text('\n'.join(('foo', 'bar')))

    def test_simple(self):
        vim.current.window.cursor = 2, 0 # rows starts from 1, column from 0
        # ... let's assume our plugin swaps lines
        self.assertEqual(vim.current.buffer[0], 'bar')
        self.assertEqual(vim.current.buffer[1], 'foo')

Development

Please use github’s issue tracker for filing new issues. Preferred way of attaching patches is via pull requests.

Work in progress

Please note that vimmock is a work-in-progress module. Only basic mocks are actually completed. If you want to use this module for now it is best if you fork it, link to your PYTHONPATH environment variable and modify on the fly. Pull requests are welcome!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vimmock-0.1.1.tar.gz (4.4 kB view details)

Uploaded Source

File details

Details for the file vimmock-0.1.1.tar.gz.

File metadata

  • Download URL: vimmock-0.1.1.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for vimmock-0.1.1.tar.gz
Algorithm Hash digest
SHA256 da275e1f3d854c18eaf33fd7826c039c2c4ce332ba263a4c7f9c0f2d281cc1c3
MD5 9cc36de636983ab7d5c066ddf15b0d0c
BLAKE2b-256 d74f1398fba6f6d47d5b4bc1d04aad9be07b9da2d45200fa5c54497901f9b246

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page