Anki/tests/test_sync.py
Damien Elmes 0c9672e7b8 rewrite media support
- media is no longer hashed, and instead stored in the db using its original
  name
- when adding media, its checksum is calculated and used to look for
  duplicates
- duplicate filenames will result in a number tacked on the file
- the size column is used to count card references to media. If media is
  referenced in a fact but not the question or answer, the count will be zero.
- there is no guarantee media will be listed in the media db if it is unused
  on the question & answer
- if rebuildMediaDir(delete=True), then entries with zero references are
  deleted, along with any unused files in the media dir.
- rebuildMediaDir() will update the internal checksums, and set the checksum
  to "" if a file can't be found
- rebuildMediaDir() is a lot less destructive now, and will leave alone
  directories it finds in the media folder (but not look in them either)
- rebuildMediaDir() returns more information about the state of media now
- the online and mobile clients will need to to make sure that when
  downloading media, entries with no checksum are non-fatal and should not
  abort the download process.
- the ref count is updated every time the q/a is updated - so the db should be
  up to date after every add/edit/import
- since we look for media on the q/a now, card templates like '<img
  src="{{{field}}}">' will work now
- export original files as gone as it is not needed anymore
- move from per-model media URL to deckVar. downloadMissingMedia() uses this
  now. Deck subscriptions will have to be updated to share media another way.
- pass deck in formatQA, as latex support is going to change
2010-12-11 01:19:31 +09:00

330 lines
11 KiB
Python

# coding: utf-8
import nose, os, tempfile, shutil, time
from tests.shared import assertException
from anki.errors import *
from anki import DeckStorage
from anki.db import *
from anki.stdmodels import BasicModel
from anki.sync import SyncClient, SyncServer, HttpSyncServer, HttpSyncServerProxy
from anki.sync import copyLocalMedia
from anki.stats import dailyStats, globalStats
from anki.facts import Fact
from anki.cards import Card
from anki.models import FieldModel
from anki.media import rebuildMediaDir
#import psyco; psyco.profile()
# Local tests
##########################################################################
deck1=None
deck2=None
client=None
server=None
def setup_local(loadDecks=None):
global deck1, deck2, client, server
if loadDecks:
deck1 = DeckStorage.Deck(loadDecks[0], backup=False)
deck2 = DeckStorage.Deck(loadDecks[1], backup=False)
else:
deck1 = DeckStorage.Deck()
deck1.addModel(BasicModel())
deck1.currentModel.cardModels[1].active = True
deck1.newCardOrder = 1
f = deck1.newFact()
f['Front'] = u"foo"; f['Back'] = u"bar"; f.tags = u"foo"
deck1.addFact(f)
deck2 = DeckStorage.Deck()
deck2.addModel(BasicModel())
deck2.currentModel.cardModels[1].active = True
f = deck2.newFact()
f['Front'] = u"baz"; f['Back'] = u"qux"; f.tags = u"bar"
deck2.addFact(f)
deck2.newCardOrder = 1
client = SyncClient(deck1)
server = SyncServer(deck2)
client.setServer(server)
def teardown():
pass
@nose.with_setup(setup_local, teardown)
def test_localsync_diffing():
assert deck1.cardCount == 2
assert deck2.cardCount == 2
lsum = client.summary(deck1.lastSync)
rsum = server.summary(deck1.lastSync)
result = client.diffSummary(lsum, rsum, 'cards')
assert len(result[0]) == 2
assert len(result[1]) == 0
assert len(result[2]) == 2
assert len(result[3]) == 0
result = client.diffSummary(lsum, rsum, 'facts')
assert len(result[0]) == 1
assert len(result[1]) == 0
assert len(result[2]) == 1
assert len(result[3]) == 0
@nose.with_setup(setup_local, teardown)
def test_localsync_deck():
# deck two was modified last
assert deck2.modified > deck1.modified
d2mod = deck2.modified
assert deck1.lastSync == 0 and deck2.lastSync == 0
client.sync()
assert deck1.modified == deck2.modified
assert deck1.modified <= deck1.lastSync
assert deck1.lastSync == deck2.lastSync
# ensure values are being synced
deck1.lowPriority += u",foo"
deck1.updateAllPriorities()
deck1.setModified()
client.sync()
assert "foo" in deck2.lowPriority
assert deck1.modified == deck2.modified
assert deck1.lastSync == deck2.lastSync
deck2.description = u"newname"
deck2.setModified()
client.sync()
assert deck1.description == u"newname"
# the most recent change should take precedence
deck1.description = u"foo"
deck1.setModified()
deck2.description = u"bar"
deck2.setModified()
client.sync()
assert deck1.description == "bar"
# answer a card to ensure stats & history are copied
c = deck1.getCard()
deck1.answerCard(c, 4)
client.sync()
assert dailyStats(deck2).reps == 1
assert globalStats(deck2).reps == 1
assert deck2.s.scalar("select count(*) from reviewHistory") == 1
# make sure meta data is synced
deck1.setVar("foo", 1)
assert deck1.getInt("foo") == 1
assert deck2.getInt("foo") is None
client.sync()
assert deck1.getInt("foo") == 1
assert deck2.getInt("foo") == 1
@nose.with_setup(setup_local, teardown)
def test_localsync_models():
client.sync()
# add a model
deck1.addModel(BasicModel())
assert len(deck1.models) == 3
assert len(deck2.models) == 2
client.sync()
assert len(deck2.models) == 3
assert deck1.currentModel.id == deck2.currentModel.id
# delete the recently added model
deck2.deleteModel(deck2.currentModel)
assert len(deck2.models) == 2
client.sync()
assert len(deck1.models) == 2
assert deck1.currentModel.id == deck2.currentModel.id
# make a card model inactive
assert deck1.currentModel.cardModels[1].active == True
deck2.currentModel.cardModels[1].active = False
deck2.currentModel.setModified()
deck2.setModified()
client.sync()
assert deck1.currentModel.cardModels[1].active == False
# remove a card model
deck1.deleteCardModel(deck1.currentModel,
deck1.currentModel.cardModels[1])
deck1.currentModel.setModified()
deck1.setModified()
assert len(deck1.currentModel.cardModels) == 1
client.sync()
assert len(deck2.currentModel.cardModels) == 1
# add a field
c = deck1.getCard()
deck1.addFieldModel(c.fact.model, FieldModel(u"yo"))
deck1.s.refresh(c.fact)
assert len(c.fact.fields) == 3
assert c.fact['yo'] == u""
client.sync()
c2 = deck2.s.query(Card).get(c.id)
deck2.s.refresh(c2.fact)
assert c2.fact['yo'] == u""
# remove the field
assert "yo" in c2.fact.keys()
deck2.deleteFieldModel(c2.fact.model, c2.fact.model.fieldModels[2])
deck2.s.refresh(c2.fact)
assert "yo" not in c2.fact.keys()
client.sync()
deck1.s.refresh(c.fact)
assert "yo" not in c.fact.keys()
# rename a field
assert u"Front" in c.fact.keys()
deck1.renameFieldModel(deck1.currentModel,
deck1.currentModel.fieldModels[0],
u"Sideways")
client.sync()
assert deck2.currentModel.fieldModels[0].name == u"Sideways"
@nose.with_setup(setup_local, teardown)
def test_localsync_factsandcards():
assert deck1.factCount == 1 and deck1.cardCount == 2
assert deck2.factCount == 1 and deck2.cardCount == 2
client.sync()
deck1.reset(); deck2.reset()
assert deck1.factCount == 2 and deck1.cardCount == 4
assert deck2.factCount == 2 and deck2.cardCount == 4
# ensure the fact was copied across
f1 = deck1.s.query(Fact).first()
f2 = deck1.s.query(Fact).get(f1.id)
f1['Front'] = u"myfront"
f1.setModified()
deck1.setModified()
client.sync()
deck1.rebuildCounts()
deck2.rebuildCounts()
f2 = deck1.s.query(Fact).get(f1.id)
assert f2['Front'] == u"myfront"
c1 = deck1.getCard()
c2 = deck2.getCard()
assert c1.id == c2.id
@nose.with_setup(setup_local, teardown)
def test_localsync_threeway():
# deck1 (client) <-> deck2 (server) <-> deck3 (client)
deck3 = DeckStorage.Deck()
client2 = SyncClient(deck3)
server2 = SyncServer(deck2)
client2.setServer(server2)
client.sync()
client2.sync()
# add a new question
f = deck1.newFact()
f['Front'] = u"a"; f['Back'] = u"b"
f = deck1.addFact(f)
card = f.cards[0]
client.sync()
assert deck1.cardCount == 6
assert deck2.cardCount == 6
# check it propagates from server to deck3
client2.sync()
assert deck3.cardCount == 6
# delete a card on deck1
deck1.deleteCard(card.id)
client.sync()
deck1.reset(); deck2.reset()
assert deck1.cardCount == 5
assert deck2.cardCount == 5
# make sure the delete is now propagated from the server to deck3
client2.sync()
assert deck3.cardCount == 5
def test_localsync_media():
tmpdir = "/tmp/media-tests"
try:
shutil.rmtree(tmpdir)
except OSError:
pass
shutil.copytree(os.path.join(os.path.dirname(__file__), "..",
"tests/syncing/media-tests"),
tmpdir)
deck1anki = os.path.join(tmpdir, "1.anki")
deck2anki = os.path.join(tmpdir, "2.anki")
deck1media = os.path.join(tmpdir, "1.media")
deck2media = os.path.join(tmpdir, "2.media")
setup_local((deck1anki, deck2anki))
assert len(os.listdir(deck1media)) == 2
assert len(os.listdir(deck2media)) == 1
client.sync()
# metadata should have been copied
assert deck1.s.scalar("select count(1) from media") == 3
assert deck2.s.scalar("select count(1) from media") == 3
# copy local files
copyLocalMedia(deck1, deck2)
assert len(os.listdir(deck1media)) == 2
assert len(os.listdir(deck2media)) == 3
copyLocalMedia(deck2, deck1)
assert len(os.listdir(deck1media)) == 3
assert len(os.listdir(deck2media)) == 3
# check delete
os.unlink(os.path.join(deck1media, "22161b29b0c18e068038021f54eee1ee.png"))
rebuildMediaDir(deck1)
client.sync()
assert deck1.s.scalar("select count(1) from media") == 3
assert deck2.s.scalar("select count(1) from media") == 3
# One way syncing
##########################################################################
@nose.with_setup(setup_local, teardown)
def test_oneway_simple():
assert deck1.s.scalar("select count(1) from cards") == 2
assert deck2.s.scalar("select count(1) from cards") == 2
assert deck1.cardCount == 2
assert deck2.cardCount == 2
assert deck1.s.scalar("select id from tags where tag = 'foo'")
assert not deck1.s.scalar("select id from tags where tag = 'bar'")
server.deckName = "dummy"
client.syncOneWay(0)
assert deck1.s.scalar("select count(1) from cards") == 4
assert deck2.s.scalar("select count(1) from cards") == 2
assert deck1.cardCount == 4
assert deck2.cardCount == 2
assert deck1.s.scalar("select id from tags where tag = 'foo'")
assert deck1.s.scalar("select id from tags where tag = 'bar'")
# should be a noop
client.syncOneWay(0)
# Remote tests
##########################################################################
# a replacement runCmd which just calls our server directly
def runCmd(action, *args, **kargs):
#print action, kargs
return server.unstuff(apply(getattr(server, action), tuple(args) +
tuple(kargs.values())))
def setup_remote():
setup_local()
global client, server
proxy = HttpSyncServerProxy("test", "foo")
client = SyncClient(deck1)
client.setServer(proxy)
proxy.deckName = "test"
proxy.runCmd = runCmd
server = HttpSyncServer()
server.deck = deck2
server.decks = {"test": (deck2.modified, 0)}
@nose.with_setup(setup_remote, teardown)
def test_remotesync_fromserver():
# deck two was modified last
assert deck2.modified > deck1.modified
client.sync()
assert deck2.modified == deck1.modified
# test deck vars
deck1.setVar("foo", 1)
client.sync()
@nose.with_setup(setup_remote, teardown)
def test_remotesync_toserver():
deck1.setModified()
client.sync()
assert deck2.modified == deck1.modified
# Full sync
##########################################################################
@nose.with_setup(setup_remote, teardown)
def test_formdata():
global deck1
(fd, name) = tempfile.mkstemp()
deck1 = deck1.saveAs(name)
deck1.setModified()
client.deck = deck1
client.prepareSync()
client.prepareFullSync()