Files
canina/scripts/seo-performance/test_clarity.py
T

73 lines
5.5 KiB
Python

import datetime as dt
import json
import tempfile
import unittest
from pathlib import Path
from unittest.mock import Mock
import requests
import seo_performance_tracker as w
DATA=[{'metricName':'Traffic','information':[{'totalSessionCount':'12','distantUserCount':'8','email':'private@example.invalid'}]}]
class ClarityTests(unittest.TestCase):
def setUp(self):
self.tmp=tempfile.TemporaryDirectory(); self.store=w.Store(Path(self.tmp.name)/'state.db'); self.session=Mock()
self.session.get.return_value.status_code=200; self.session.get.return_value.json.return_value=DATA
def tearDown(self): self.store.db.close(); self.tmp.cleanup()
def collector(self,**kw): return w.ClarityCollector(self.store,self.session,'test-token','project',**kw)
def test_project_cache_survives_reopen_and_no_article_attribution(self):
a=self.collector().collect('https://canina.ir/blog/a'); self.store.db.close(); self.store=w.Store(Path(self.tmp.name)/'state.db')
b=self.collector().collect('https://canina.ir/blog/b')
self.assertEqual(self.session.get.call_count,1); self.assertEqual(a,b)
self.assertEqual(a['scope'],'project'); self.assertEqual(a['metrics']['Traffic'][0]['totalSessionCount'],12)
self.assertNotIn('private',json.dumps(a)); self.assertEqual(a['window']['numOfDays'],3)
args=self.session.get.call_args
self.assertEqual(args.args[0],w.CLARITY_ENDPOINT); self.assertFalse(args.kwargs['allow_redirects']); self.assertEqual(args.kwargs['timeout'],(5,30))
self.assertEqual(args.kwargs['headers'],{'Authorization':'Bearer test-token'})
def test_failures_are_null_cached_sanitized(self):
for code in (401,403,429,302,500):
self.session.get.return_value.status_code=code
r=self.collector(project_suffix= str(code)).collect()
self.assertEqual(r['error'],f'http_{code}'); self.assertIsNone(r['metrics'])
self.session.get.side_effect=requests.Timeout('test-token private')
r=self.collector(project_suffix='timeout').collect(); self.assertEqual(r['error'],'network_error'); self.assertNotIn('test-token',json.dumps(r))
def test_malformed_partial(self):
for i,data in enumerate(({},[{'metricName':'Traffic','information':[]}],DATA+[{'metricName':'Oops'}], [{'metricName':'Traffic','information':[{'totalSessionCount':'NaN'}]}])):
self.session.get.return_value.json.return_value=data
r=self.collector(project_suffix=str(i)).collect(); self.assertEqual(r['status'],'unavailable'); self.assertIsNone(r['metrics'])
def test_exact_url_only(self):
self.session.get.return_value.json.return_value=[{'metricName':'Traffic','information':[{'URL':'https://canina.ir/blog/a','totalSessionCount':'2'},{'URL':'https://canina.ir/blog/b?email=private','totalSessionCount':'9'}]}]
c=self.collector(dimensions=('URL',)); a=c.collect('https://canina.ir/blog/a'); b=c.collect('https://canina.ir/blog/a/')
self.assertEqual(a['scope'],'article'); self.assertEqual(a['metrics']['Traffic'][0]['totalSessionCount'],2)
self.assertIsNone(b['metrics']); self.assertEqual(b['error'],'exact_page_not_reported'); self.assertNotIn('private',json.dumps(a)); self.assertEqual(self.session.get.call_count,1)
def test_limits_missing_credentials(self):
for days in (0,4):
with self.assertRaises(ValueError): self.collector(days=days)
with self.assertRaises(ValueError): self.collector(dimensions=('URL','Browser','OS','Device'))
self.assertEqual(w.ClarityCollector(self.store,self.session,None,'project').collect()['error'],'credentials_not_configured'); self.session.get.assert_not_called()
def test_budget(self):
for n in range(11): r=self.collector(dimensions=('URL',) if n%2 else (),project_suffix='budget',day=dt.date(2026,10,28)+dt.timedelta(days=0),days=(n%3)+1).collect()
# Six unique supported windows consume six requests; repeats reuse cache.
self.assertEqual(self.session.get.call_count,6)
def test_hard_daily_cap_and_day_rollover(self):
c=self.collector(day=dt.date(2026,10,28))
with self.store.db:
for n in range(10): self.store.db.execute('INSERT INTO clarity_cache VALUES (?,?,?,?)',(str(n),c.project,c.day,'{}'))
self.assertEqual(c.collect()['error'],'daily_budget_exhausted'); self.session.get.assert_not_called()
self.assertEqual(self.collector(day=dt.date(2026,10,29)).collect()['status'],'available')
def test_real_numeric_shape(self):
self.session.get.return_value.json.return_value=[{'metricName':'Traffic','information':[{'totalSessionCount':'12','distinctUserCount':'8','pagesPerSessionPercentage':1.2}]},{'metricName':'DeadClickCount','information':[{'pagesViews':'3','sessionsCount':'2','subTotal':'1'}]}]
r=self.collector().collect()
self.assertEqual(r['metrics']['Traffic'][0]['distinctUserCount'],8)
self.assertEqual(r['metrics']['DeadClickCount'][0]['pagesViews'],3)
def test_finding_uses_shared_collector(self):
google=Mock(); google.gsc_page.return_value=w.unavailable('test'); google.gsc.return_value=w.unavailable('test'); google.ga4.return_value=w.unavailable('test')
c=self.collector()
for fid in ('a','b'):
p=w.collect_finding({'id':fid,'articleUrl':'https://canina.ir/blog/'+fid},google,('2026-10-01','2026-10-14'),self.store,c)
self.assertEqual(p['sources']['clarity']['scope'],'project')
self.assertEqual(self.session.get.call_count,1)
def test_metadata_and_catalog(self):
p={'periodStart':'2026-10-01','periodEnd':'2026-10-14','sources':{'clarity':self.collector().collect()},'feedbackRevision':1}
b=w.snapshot_body(p,'k'); self.assertEqual(b['sourceMetadata']['clarity']['scope'],'project'); self.assertNotIn('attributedOrdersCount',b)
if __name__=='__main__': unittest.main()