mirror of
https://github.com/beetbox/beets.git
synced 2025-12-06 16:42:42 +01:00
d9582f4bea
This adds support for the JSON Lines format as documented at https://jsonlines.org/. In this mode the data is output incrementally, whereas the other modes load every item into memory and don't produce output until the end.
113 lines
3.6 KiB
Python
113 lines
3.6 KiB
Python
# -*- coding: utf-8 -*-
|
|
# This file is part of beets.
|
|
# Copyright 2019, Carl Suster
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining
|
|
# a copy of this software and associated documentation files (the
|
|
# "Software"), to deal in the Software without restriction, including
|
|
# without limitation the rights to use, copy, modify, merge, publish,
|
|
# distribute, sublicense, and/or sell copies of the Software, and to
|
|
# permit persons to whom the Software is furnished to do so, subject to
|
|
# the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be
|
|
# included in all copies or substantial portions of the Software.
|
|
|
|
"""Test the beets.export utilities associated with the export plugin.
|
|
"""
|
|
|
|
from __future__ import division, absolute_import, print_function
|
|
|
|
import unittest
|
|
from test.helper import TestHelper
|
|
import re # used to test csv format
|
|
import json
|
|
from xml.etree.ElementTree import Element
|
|
from xml.etree import ElementTree
|
|
|
|
|
|
class ExportPluginTest(unittest.TestCase, TestHelper):
|
|
def setUp(self):
|
|
self.setup_beets()
|
|
self.load_plugins('export')
|
|
self.test_values = {'title': 'xtitle', 'album': 'xalbum'}
|
|
|
|
def tearDown(self):
|
|
self.unload_plugins()
|
|
self.teardown_beets()
|
|
|
|
def execute_command(self, format_type, artist):
|
|
query = ','.join(self.test_values.keys())
|
|
out = self.run_with_output(
|
|
'export',
|
|
'-f', format_type,
|
|
'-i', query,
|
|
artist
|
|
)
|
|
return out
|
|
|
|
def create_item(self):
|
|
item, = self.add_item_fixtures()
|
|
item.artist = 'xartist'
|
|
item.title = self.test_values['title']
|
|
item.album = self.test_values['album']
|
|
item.write()
|
|
item.store()
|
|
return item
|
|
|
|
def test_json_output(self):
|
|
item1 = self.create_item()
|
|
out = self.execute_command(
|
|
format_type='json',
|
|
artist=item1.artist
|
|
)
|
|
json_data = json.loads(out)[0]
|
|
for key, val in self.test_values.items():
|
|
self.assertTrue(key in json_data)
|
|
self.assertEqual(val, json_data[key])
|
|
|
|
def test_jsonlines_output(self):
|
|
item1 = self.create_item()
|
|
out = self.execute_command(
|
|
format_type='jsonlines',
|
|
artist=item1.artist
|
|
)
|
|
json_data = json.loads(out)
|
|
for key, val in self.test_values.items():
|
|
self.assertTrue(key in json_data)
|
|
self.assertEqual(val, json_data[key])
|
|
|
|
def test_csv_output(self):
|
|
item1 = self.create_item()
|
|
out = self.execute_command(
|
|
format_type='csv',
|
|
artist=item1.artist
|
|
)
|
|
csv_list = re.split('\r', re.sub('\n', '', out))
|
|
head = re.split(',', csv_list[0])
|
|
vals = re.split(',|\r', csv_list[1])
|
|
for index, column in enumerate(head):
|
|
self.assertTrue(self.test_values.get(column, None) is not None)
|
|
self.assertEqual(vals[index], self.test_values[column])
|
|
|
|
def test_xml_output(self):
|
|
item1 = self.create_item()
|
|
out = self.execute_command(
|
|
format_type='xml',
|
|
artist=item1.artist
|
|
)
|
|
library = ElementTree.fromstring(out)
|
|
self.assertIsInstance(library, Element)
|
|
for track in library[0]:
|
|
for details in track:
|
|
tag = details.tag
|
|
txt = details.text
|
|
self.assertTrue(tag in self.test_values, msg=tag)
|
|
self.assertEqual(self.test_values[tag], txt, msg=txt)
|
|
|
|
|
|
def suite():
|
|
return unittest.TestLoader().loadTestsFromName(__name__)
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main(defaultTest='suite')
|