DevOps Core

DevOps Core je vsebinska osnova zbirke DevOps: projekti, vloge, navigacija po vozliščih in stikala funkcij, na katere se opirajo vsi paketi DWDO. Projekt pri tem ni zapis v zbirki podatkov, temveč imenski prostor. Paket je namenjen upraviteljem, ki postavljajo projekte in vloge, in razvijalcem vtičnikov, ki v zbirko vključijo lasten paket.

Hitri začetek: ustvarjanje in odpiranje prvega projekta – najkrajša pot do prvega rezultata, v treh korakih.

Določite koren projektov → Dodelite vloge → Preverite vozlišča

Temelj plasti DWDO: kaj je projekt, kdo sme v njem kaj, in kako je videti navigacija znotraj projekta. Vsak paket DWDO gradi na tem, namesto da bi prinesel lastno predstavo o teh stvareh.

Paket sam ne izriše nobenega zaslona. V registru storitev paketa Core registrira pet storitev in jih s tem da na voljo vsem drugim paketom.

Vseh pet je registriranih prek registerFactory(): objekt nastane šele ob prvem get() z njegovim identifikatorjem. Zahteva, ki se ne dotakne nobenega projekta DWDO, torej ne zgradi nobenega od njih.

• Wiki naj gosti več projektov, ki drug drugega ne vidijo, ne da bi vsak prinesel lastno upravljanje pravic.
• Več paketov DWDO naj ima enako predstavo o tem, kaj je »trenutni projekt«.
• Vrstica projekta naj prikaže le vnose, katerih zasloni na tej namestitvi dejansko obstajajo.
• Drug paket naj lahko prispeva lastno vozlišče ali lastno vlogo, ne da bi wkdocore moral vedeti zanj.

Zasloni sami niso predmet tega paketa. Delovni elementi, poizvedbe, cevovodi in shramba so v lastnih paketih (glejte Glejte tudi).

Projekt je najprej imenski prostor pod korenom projektov. S tem podeduje vse, kar DokuWiki zmore z imenskimi prostori – seznam dostopa (ACL), iskanje, varnostno kopiranje, različice – ne da bi bilo treba karkoli od tega zgraditi znova.

projectroot ni vezan na en sam imenski prostor. Če vrednost vsebuje nadomestni znak {lang}, ga action_plugin_wkdocore::roots() razreši enkrat za vsak jezik iz projectlangs in vrne ustrezno število korenov.

Zakaj to ni le stvar reda. Predloga, ki jezik prikaza izpelje iz začetnega dela xx: v identifikatorju strani, od strani pod korenom brez jezika ne dobi ničesar. Njena iskanja navzgor – stranska vrstica, tema – tedaj zapustijo jezik in posežejo v ves wiki. Nadomestni znak omogoča, da so strani projektov znotraj jezikovnih imenskih prostorov (sl:projects:acme:…), ne pa v jezikovno nevtralnem korenu ob njih.

Paket je dobavljen s projectroot = projects, torej brez nadomestnega znaka. To je namerno: obstoječa namestitev ob posodobitvi ohrani svojo razporeditev. Nadomestni znak je odločitev upravljavca – in ta jo sprejme enkrat, ker je poznejša sprememba selitev vseh strani, ne zamenjava nastavitve.

Nad seznamom dostopa DokuWiki je plast vlog iz skupin oblike @dwdo_<projekt>_maintainers / _contributors / _readers. Predpono dwdo_ je mogoče spremeniti z nastavitvijo roleprefix.

Vloge ne nadomeščajo seznama dostopa, temveč so nad njim: stran, ki je uporabnik po ACL ne sme brati, mu ostane skrita tudi pri visoki vlogi. Vloga odloča, katere funkcije projekta lahko nekdo uporablja.

Role::atLeast() primerja dve vlogi po njuni stopnji. Če ena od njiju ni na lestvici, vrne primerjava false – ne sproži izjeme in ne privzame nobene stopnje.

To je zavestna varnostna odločitev: vozlišče ali funkcija, zavarovana z neznanim imenom vloge (zaradi tipkarske napake ali ker je vloga iz paketa, katerega klic defineLevel() se nikoli ni izvedel), se skrije, ne odklene.

Vrstica znotraj projekta. HubRegistry::defaults() vrne osem vozlišč:

hub.settings je edino vozlišče, ki ne zahteva le reader in pravice za branje. Zahteva maintainer in pravico za urejanje. Obe preverjanji tečeta neodvisno drugo od drugega, izrecno kot večplastna zaščita.

Štiri od osmih vozlišč kažejo na zaslon, ki pripada lastnemu paketu – izginejo, če ta paket manjka ali je izklopljen. Druga štiri kažejo na običajne strani wikija, ki jih ekipa napiše sama; ne potrebujejo nobenega paketa, zato se prikažejo vedno.

»Nameščen« pri tem pomeni nameščen in vklopljen: preverjanje teče prek plugin_isdisabled(), DokuWiki pa neznan paket sporoči kot izklopljen. Paket, ki je v upravitelju razširitev izklopljen, je tako enako nedosegljiv kot manjkajoč – in njegovo vozlišče v obeh primerih izgine.

Razlog, da vozlišče brez zaslona izgine, namesto da bi vodilo v prazno, je izpisan v kodi in sodi sem: vidno vozlišče, ki ne vodi nikamor, stane klik in bralca nauči, da navigacija laže. Skrito pove »tukaj ne«, in to drži.

FeatureFlags::resolve() za vsak ključ odloča v tem vrstnem redu; zmaga prva stopnja, ki velja:

1. Preglasitev za projekt – zmaga vedno, tudi nad manjkajočim paketom. Razlog: reserved
2. Paket sporoči, da ni na voljo – izklopi ne glede na privzeto vrednost. Razlog: plugin-missing
3. Privzeta vrednost za ves wiki iz disabledhubs – razlog: default oziroma suite-disabled
4. Nobena stopnja ni odločila – stikalo je vklopljeno. Razlog: default

Vozlišča vodijo do področij posameznega projekta. Če morate najprej vedeti, kateri projekti in repozitoriji sploh obstajajo, potrebujete raven pred tem – zato obstajata dve storitvi imenika in štirje gradniki skladnje.

Imenik projektov združi štiri vire – vnaprej določene oznake, pregled imenskih prostorov, shranjene zapise projektov in dogodek WKDOCORE_PROJECT_DISCOVER. Posamezno poizvedbo in seznam izpelje iz iste množice: projekta, ki ga seznam ne pokaže, tudi s posamezno poizvedbo ni mogoče dokazati. Sicer bi bila poizvedba vir podatkov o projektih, ki jih spraševalec ne sme videti.

Vsi štirje kličejo nocache(): njihov izpis je odvisen od računa, in predpomnjena stran bi naslednjemu obiskovalcu pokazala izbor prejšnjega.

{{wk:explore>}} ni tretja izvedba istih seznamov, temveč kliče druga dva gradnika. Filtri, napisi, prazna stanja in preverjanje pravic zato obstajajo natanko enkrat. Parametri poizvedbe se ne prekrivajo: seznam projektov bere pq/pscope/pstatus, seznam repozitorijev rq/rp/ro, q pa ostane iskanju po celotnem besedilu wikija. Oba filtra zato na skupni strani delujeta neodvisno drug od drugega, filtriran pogled pa je naslov, ki ga je mogoče posredovati.

Možnost: size=<n> nastavi velikost strani v tabeli repozitorijev. Seznam repozitorijev je v tem gradniku trdno nastavljen na vse projekte – tu je vstopna točka prek vseh projektov, tudi če je stran v imenskem prostoru projekta.

{{wk:repos>}} se ravna po strani, na kateri je. Znotraj projekta prikaže repozitorije tega projekta, zunaj vse. Nekoč je bilo obratno, in tako je nastala stran z naslovom Repozitoriji tega projekta, ki je naštela repozitorije vseh projektov. Zdravilo je bilo ročno vpisati oznako projekta. Ta pa je izpeljiva iz imenskega prostora strani, ob tipkarski napaki tiho vodi v prazen seznam in je nekaj, kar mora vedeti avtor, namesto da bi stran to vedela sama o sebi. Iz istega razloga {{wk:explore>}} zgoraj izrecno nastavi project=all: vstopni pregled, ki naj pokaže celotno pokrajino, tega ne sme delati odvisnega od tega, kje je po naključju.

Oba seznama ob vrstici z zadetki povežeta na napisana navodila za svoj zaslon, in to le, če ta stran na tej namestitvi res obstaja. Če navodilo ni napisano, povezave preprosto ni – mrtva povezava ne nastane nikoli.

do=wkdocore_members&project=<oznaka> pokaže, kdo ima v projektu katero vlogo, in vloge dodeljuje. To ni zaslon skrbništva wikija, temveč lastno dejanje – in prav to je odločilna razlika: skrbništvo preverja status upravitelja za ves wiki, ta zaslon pa vlogo v projektu. Maintainer pride noter, ne da bi bil skrbnik wikija; skrbnik wikija, ki v nobenem projektu nima vloge, pride noter kljub temu.

Meja je določena v Domain/ProjectMembership, ne v vmesniku: zaslon stopnje, ki je opazovalec ne sme dodeliti, sploh ne ponudi, preverjanje pa zavrne tudi ročno sestavljeno pošiljanje iste stopnje. Dve ravni, ker je prva le oznaka v HTML, oznaka pa ni preverjanje pravic.

Dodelitev vloge nadomesti dosedanjo stopnjo, ne doda je: razreševanje vlog vzame prvi zadetek od zgoraj, zato dodatna šibkejša skupina ne bi več ničesar odločala in bi bila le podatek, ki nasprotuje dejanskemu stanju. Že obstoječa podvajanja so poimenovana za vsako vrstico posebej, a niso odstranjena brez vprašanja.

Razdelilnik zahtev paketa wkrequest za ROLE_REQUEST in ACCESS_REQUEST kaže na ta zaslon. Prej je kazal na upravljanje uporabnikov wikija – zato je vsaka prošnja za članstvo v katerem koli projektu končala pri eni sami osebi, ne glede na to, kdo projekt vodi.

{{wk:repos>}} skrije stolpce, ki jih nobena vrstica ne more izpolniti. Privzeta veja je na voljo, ker jo vrne ena sama skupna poizvedba za vsako povezavo – pri 61 vključenih repozitorijih so to štiri zahteve, ne 61, odgovor pa se predpomni. Jezik in zadnja sprememba bi stala po eno zahtevo na vrstico; vir vpetja teh podatkov zato še naprej ne zagotavlja, stolpca pa se sploh ne prikažeta, namesto da bi ostala prazna.

Osem nastavitev, v Splošnih nastavitvah pod plugin » wkdocore. Stolpec Privzeto navaja dobavljeno vrednost, ne vrednosti, nastavljene na tej namestitvi.

Vsako vrednost normalizira cleanID(), prazni vnosi odpadejo, podvojeni se združijo. Seznam, ločen z vejicami, s presledki okrog vnosov je torej dovoljen.

Pet mest, na katerih lahko drug paket prispeva, ne da bi ga wkdocore moral poznati:

Noben od treh dogodkov nima privzete obravnave v jedru: obravnavalniki svoj prispevek vpišejo neposredno v skupni register.

Vir repozitorijev vrača že preverjene vrstice. Pogodba zahteva štiri stvari: vir sam filtrira po pravicah, nikoli ne sproži izjeme, navaja le repozitorije, za katere lahko jamči, in sporočene zmožnosti so dejanske. Raziskovalec zato ne potrebuje posebnega primera za vsako zaledje – wkdoadogit se v njem pojavi z namestitvijo, ne s spremembo kode v vmesniku projekta.

?do=wkdocore_diag prikaže razrešeni DwdoContext kot JSON: dejavni projekt, vlogo prijavljenega uporabnika, vidna vozlišča, stikala funkcij z razlogom za vsak ključ, uporabniško ime in oznako skrbnika. To je najhitrejši odgovor na vprašanje »zakaj ne vidim tega menijskega vnosa« – razlog je izpisan dobesedno (reserved, plugin-missing, suite-disabled, default).

Preverjanje registra poteka po načelu »duck typing« prek method_exists(), ne prek navedbe tipa. Core je odvisnost med izvajanjem, ki pride prek plugin_load(), ne trdna vključitev – zato mora koda prenesti manjkajočo ali tujo vsebino.

• Core – register storitev, v katerem je registriranih pet storitev dwdo.*
• Vtičnik DevOps Storage – shramba, vključno z dwdo_projects in njenimi tujimi ključi
• Azure DevOps Connector – povezava z Azure DevOps
• Boards, Dashboard, Cevovodi, Queries, Work Items – paketi za štirimi vozlišči, vezanimi na pakete
• wkfluentui – lupina, v katere desni stolpec se izriše vrstica vozlišč
• wkdoadogit – vir repozitorijev, ki vključene repozitorije Git vpiše v raziskovalca
• Delo s projekti – isti gradniki z vidika bralcev, z navodili

Paket: wkdocore
Mapa: lib/plugins/wkdocore/
Avtor: Wolfgang van der Stille Wolfgang.van.der.Stille@gmail.com (The White Knight Labs)
Licenca: GPL-2.0-only