SL-18330: Merge branch 'main' into sl-18330-fix

Author: nat-goodspeed

.github/workflows/bench.yaml

@@ -0,0 +1,35 @@
+name: Benchmark 
+
+on:
+  pull_request:
+
+permissions:
+  contents: write
+  deployments: write
+
+jobs:
+  benchmark:
+    name: Run benchmarks 
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Run benchmarks
+        run: |
+          pip install .[dev] 
+          pytest tests/bench.py --benchmark-json benchmark.json
+
+      - name: Store results
+        uses: benchmark-action/github-action-benchmark@v1
+        with:
+          name: Python Benchmarks
+          tool: pytest
+          output-file-path: benchmark.json
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          auto-push: true
+          alert-threshold: "110%"
+          comment-on-alert: true

.github/workflows/ci.yaml

@@ -43,7 +43,9 @@ jobs:
 
       - name: Upload coverage
         uses: codecov/codecov-action@v3
+        if: matrix.python-version == '3.10'
         with:
+          token: ${{ secrets.CODECOV_TOKEN }}
           env_vars: PYTHON
           fail_ci_if_error: true
           files: .coverage.${{ steps.pyenv.outputs.value }}.xml

.gitignore

@@ -283,3 +283,5 @@ $RECYCLE.BIN/
 *.lnk
 
 # End of https://www.toptal.com/developers/gitignore/api/python,linux,windows,macos,vim,visualstudiocode
+
+.benchmarks/

setup.py

@@ -22,7 +22,7 @@
         'local_scheme': 'no-local-version', # disable local-version to allow uploads to test.pypi.org
     },
     extras_require={
-        "dev": ["pytest", "pytest-cov<3"],
+        "dev": ["pytest", "pytest-benchmark", "pytest-cov<3"],
     },
     classifiers=[
         "Intended Audience :: Developers",

tests/bench.py

@@ -0,0 +1,127 @@
+from tempfile import TemporaryFile
+import unittest
+
+import pytest
+
+import llsd
+
+BENCH_DATA_XML = b"""<?xml version="1.0" encoding="UTF-8"?>
+<llsd>
+  <map>
+    <key>integer</key>
+    <real>5000</real>
+    <key>real</key>
+    <real>0.096970</real>
+    <key>binary</key>
+    <binary>ff55ca5cef2f477f92e011c7de95bb11</binary>
+    <key>uri</key>
+    <uri>https://secondlife.com</uri>
+    <key>date</key>
+    <date>2006-02-01T14:29:53Z</date>
+    <key>children</key>
+    <array>
+      <map>
+        <key>integer</key>
+        <real>5000</real>
+        <key>real</key>
+        <real>0.096970</real>
+        <key>binary</key>
+        <binary>ff55ca5cef2f477f92e011c7de95bb11</binary>
+        <key>string</key>
+        <string>AjWwhTHctcuAxhxK</string>
+        <key>id</key>
+        <binary>ff55ca5cef2f477f92e011c7de95bb11</binary>
+        <key>int_32</key>
+        <integer>-1147906088</integer>
+        <key>bool</key>
+        <boolean>1</boolean>
+      </map>
+      <real>0.156519</real>
+      <binary>ff55ca5cef2f477f92e011c7de95bb11</binary>
+      <uri>https://secondlife.com</uri>
+      <date>2006-02-01T14:29:53Z</date>
+    </array>
+  </map>
+</llsd>"""
+
+_bench_data = llsd.parse_xml(BENCH_DATA_XML)
+BENCH_DATA_BINARY = llsd.format_binary(_bench_data)
+BENCH_DATA_NOTATION = llsd.format_notation(_bench_data)
+
+_tc = unittest.TestCase()
+_tc.maxDiff = 5000
+assertDictEqual =  _tc.assertDictEqual
+
+
+@pytest.fixture
+def xml_stream():
+    with TemporaryFile() as f:
+        f.write(BENCH_DATA_XML)
+        f.seek(0)
+        yield f 
+
+
+@pytest.fixture
+def notation_stream():
+    with TemporaryFile() as f:
+        d = llsd.format_notation(_bench_data)
+        f.write(d)
+        f.seek(0)
+        yield f
+
+
+@pytest.fixture
+def binary_stream():
+    with TemporaryFile() as f:
+        d = llsd.format_binary(_bench_data)
+        f.write(d)
+        f.seek(0)
+        yield f
+
+
+def bench_stream(parse, stream):
+    ret = parse(stream)
+    stream.seek(0)
+    return ret
+
+
+def test_parse_xml_stream(benchmark, xml_stream):
+    ret = benchmark(bench_stream, llsd.parse_xml, xml_stream)
+    assertDictEqual(ret, _bench_data)
+
+
+def test_parse_notation_stream(benchmark, notation_stream):
+    ret = benchmark(bench_stream, llsd.parse_notation, notation_stream)
+    assertDictEqual(ret, _bench_data)
+
+
+def test_parse_binary_stream(benchmark, binary_stream):
+    ret = benchmark(bench_stream, llsd.parse_binary, binary_stream)
+    assertDictEqual(ret, _bench_data)
+
+
+def test_parse_notation_bytes(benchmark):
+    ret = benchmark(llsd.parse_notation, BENCH_DATA_NOTATION)
+    assertDictEqual(ret, _bench_data)
+
+
+def test_parse_xml_bytes(benchmark):
+    res = benchmark(llsd.parse_xml, BENCH_DATA_XML)
+    assertDictEqual(res, _bench_data)
+
+
+def test_parse_binary_bytes(benchmark):
+    res = benchmark(llsd.parse_binary, BENCH_DATA_BINARY)
+    assertDictEqual(res, _bench_data)
+
+
+def test_format_xml(benchmark):
+    benchmark(llsd.format_xml, _bench_data)
+
+
+def test_format_notation(benchmark):
+    benchmark(llsd.format_notation, _bench_data)
+
+
+def test_format_binary(benchmark):
+    benchmark(llsd.format_binary, _bench_data)