Redigert av redaksjonen for Python-kodrevisjon · Bevis kontrollert: · Slik fungerer rangeringen
En kodrevisjon kan vise om en full omskriving er nødvendig, og i mange eldre Python- og Django-systemer er den ikke det. Revisjonen kartlegger kodebasen, skiller strukturelle problemer fra kosmetiske og lager en prioritert utbedringsplan med anslag over innsatsen for hvert punkt. Den planen lar en kjøper sammenligne trinnvis utbedring, delvis omskriving og full omskriving på grunnlag av bevis i stedet for frustrasjon over dagens kode. Denne veiledningen dekker beslutningssignalene, revisjonsomfanget som underbygger beslutningen, og kontrollene som holder en utbedringsplan ærlig. Den er skrevet for CTO-er, utviklingsledere og gründere som eier et Python-system de ikke har bygget eller ikke lenger stoler på.
Hva er hovedfasene i beslutningen om omskriving kontra utbedring?
Beslutningen er en sekvens av porter, ikke ett enkelt møte. Hver port gir et dokument som neste port er avhengig av, og en kjøper kan stoppe ved en hvilken som helst port hvis svaret allerede er klart.
| Fase eller beslutning | Hovedarbeid | Påkrevd leveranse | Kjøperens beslutning eller port |
|---|---|---|---|
| Innramming | Formuler forretningsproblemet som koden forårsaker: trege utgivelser, hendelser, vanskelig rekruttering, sikkerhetseksponering | Én side med problemformulering og navngitte symptomer | Er problemet koden, prosessen eller teamet? |
| Kartlegging av kodebasen | Kartlegg moduler, avhengigheter, testdekning, rammeverksversjoner, distribusjonsvei | Kart over systemet med risikoområder markert | Vet vi hva vi faktisk har? |
| Revisjon | Les koden og arkitekturen opp mot det formulerte problemet; kontroller sikkerhet, ytelse og vedlikeholdbarhet | Funnliste med alvorlighetsgrad og bevis | Er funnene strukturelle eller lokale? |
| Prioritert utbedringsplan | Grupper funnene i utbedringspunkter, anslå innsats, sett dem i rekkefølge | Rangert backlog med innsats og merknader om avhengigheter | Kan de verste problemene utbedres der de er? |
| Sammenligning av alternativer | Kostnad og risiko ved trinnvis utbedring, delvis omskriving og full omskriving | Beslutningstabell med signaler og risiko | Hvilket alternativ velger vi? |
| Validering | Ny revisjon eller målrettet gjennomgang etter første utbedringssyklus | Sammenligning av funn før og etter | Fungerer veien vi har valgt? |
Revisjonsfasen er den kjøpere oftest hopper over. Uten den hviler omskrivingsbeslutningen på utviklernes klager, som er reelle signaler, men ikke bevis for omfang.
Kan en kodegjennomgang hjelpe oss å unngå en full omskriving?
Ja, når gjennomgangen er avgrenset til å svare på det spørsmålet. En kodrevisjon som ender i en prioritert utbedringsplan, gir kjøperen et tredje alternativ mellom å leve med koden og å erstatte den. Gjennomgangen tester om problemene er konsentrert i noen få moduler eller spredt gjennom arkitekturen. Konsentrerte problemer taler vanligvis for utbedring. Spredte problemer, særlig der datamodellen eller kjerneabstraksjonene er feil, peker mot en delvis eller full omskriving.
Gjennomgangen tester også antakelsen bak de fleste omskrivingsforslag: at dagens system er uten redning. Revisorer som leser koden, kan bekrefte eller avvise den påstanden modul for modul. En utbedringsplan som først retter de høyest prioriterte punktene, lar teamet måle om kodebasen responderer. Hvis den gjør det, svekkes omskrivingsargumentet. Hvis den ikke gjør det, har kjøperen bevis for den større beslutningen.
Denne katalogens veiledning til leveranser fra Django-gjennomgang lister opp hva en gjennomgang bør overlevere, og veiledningen om revisjonsgrensen forklarer hvor en kodegjennomgang slutter og en penetrasjonstest eller samsvarsrevisjon begynner.
Når er en omskriving bedre enn refaktorering?
En omskriving er det bedre valget når revisjonen viser at problemene er strukturelle og utbedringsplanen ikke kan nå dem uten å bygge de samme grunnvollene på nytt. Tabellen nedenfor angir signalene for hvert alternativ. Den er en beslutningsstøtte, ikke en regel: funnene i revisjonen avgjør hvilken rad som gjelder.
| Alternativ | Signaler i revisjonen | Hovedrisikoer | Hva revisjonen må vise for å avgjøre |
|---|---|---|---|
| Trinnvis utbedring | Problemene klynger seg i identifiserbare moduler; kjernedatamodellen er sunn; tester finnes eller kan legges til rundt risikoområdene | Utbedringen stopper opp; gjelden kommer tilbake; teamet mister tålmodigheten før resultatene viser seg | En rangert liste over utbedringspunkter med innsats, og en første syklus som er liten nok til å fullføres |
| Delvis omskriving | Ett delsystem (autentisering, rapportering, en eldre integrasjon) er kilden til de fleste hendelsene; resten av systemet er brukbart | Grensen mellom gammelt og nytt er uklar; duplisert logikk under overgangen | En tydelig skilleflate mellom delsystemet og resten, plus en grensesnittkontrakt |
| Full omskriving | Kjerneabstraksjonene eller datamodellen er feil; hver endring berører mange moduler; rammeverksversjonen støttes ikke og kan ikke oppgraderes der den er | Årevis med skjulte forretningsregler går tapt; kostnader ved parallell drift; det nye systemet gjentar de gamle feilene | Bevis for at utbedring ikke kan nå grunnvollene, og en plan for å fange opp reglene den gamle koden koder for |
To navngitte selskaper i denne katalogen publiserer arbeid med kodrevisjon og modernisering. STX Next beskriver oppdrag med Python- og Django-gjennomgang og modernisering på nettstedet sitt, og Uvik Software lister kodegjennomgang og modernisering av eldre systemer blant tjenestene sine. Ingen av dem publiserer en regel for når en omskriving er berettiget, så beslutningen ligger hos kjøperen og funnene i revisjonen.
Hvordan avgjør du hva som skal rettes først i en eldre Python-app?
Rett først det som blokkerer forretningsproblemet som ble formulert i innrammingsfasen, deretter det som gjør fremtidige utbedringer billigere. Revisjonen bør rangere punktene etter forretningspåvirkning og etter hvor mye hver utbedring reduserer kostnaden ved den neste. En sikkerhetseksponering i et offentlig endepunkt rangerer høyere enn en navnekonvensjon, og en manglende test rundt en betalingsflyt rangerer høyere enn begge hvis den blokkerer trygge endringer.
| Prioritetsnivå | Typiske punkter | Hvorfor den kommer med | Bevis revisjonen bør gi |
|---|---|---|---|
| Først | Sikkerhetseksponeringer, risiko for datatap, ustøttede rammeverksversjoner med kjente problemer | De innebærer forretningsrisiko som vokser med tiden | Funn, plassering i koden, alvorlighetsgrad og skisse til utbedring |
| Deretter | Manglende tester rundt moduler med hyppige endringer, ødelagt utrullingsløp, avhengighetskonflikter | De gjør hver senere utbedring tregere og mer risikofylt | Dekningshull per modul og listen over avhengighetskonflikter |
| Tredje | Duplisert logikk, uklare modulgrenser, trege spørringer på kjernebaner | De øker kostnaden ved endring, men forårsaker sjelden hendelser alene | Hotspots etter endringsfrekvens og spørringstider |
| Fjerde | Stil, navngiving, død kode, mangler i dokumentasjonen | Nyttig, men endrer ikke beslutningen om omskriving | En oppryddingsliste teamet kan planlegge uten støtte fra revisjonen |
Revisjonen bør også oppgi avhengigheter mellom punktene. Et testsett som legges til før en refaktorering, endrer risikoen ved refaktoreringen, så rekkefølgen betyr like mye som rangeringen. Sjekklisten for arvet kodebase dekker kartleggingsarbeidet som ligger til grunn for denne rangeringen.
Hva er tegn på at en kodebase trenger omskriving?
Tegnene som betyr noe, er de revisjonen kan bekrefte i koden, ikke de som kjennes i standupene. Saken for omskriving er sterk når flere av følgende opptrer samtidig, og utbedringsplanen ikke kan håndtere dem uten å bygge grunnmuren på nytt.
| Varseltegn | Hvorfor det betyr noe | Kjøpers respons |
|---|---|---|
| Hver endring berører mange urelaterte moduler | Koblingen gjør hver utbedring dyrere enn den forrige | Be revisjonen kartlegge avhengigheter og teste om det finnes et skjøtested |
| Datamodellen kan ikke representere gjeldende forretningsregler | Omveier hoper seg opp i applikasjonskoden og skjuler den egentlige logikken | Be om en gjennomgang av datamodellen atskilt fra kodegjennomgangen |
| Rammeverksversjonen er ustøttet og kan ikke oppgraderes på stedet | Sikkerhetsrettelser slutter å komme, og det blir vanskeligere å rekruttere | Be revisjonen teste et oppgraderingsløp på en branch før beslutningen tas |
| Ingen tester rundt banene som endres mest | Utbedringer kan ikke verifiseres, så risikoen forblir høy uansett hva planen sier | Gjør en test-først-utbedringssyklus til første punkt i planen |
| Kunnskapen om kjernereglene sitter hos én eller to personer | En omskriving risikerer å miste regler som bare finnes i det kjørende systemet | Krev et steg for å fange opp reglene før en omskriving starter |
| Et forslag om omskriving har ingen revisjon bak seg | Omfanget og kostnaden er gjetninger | Bestill revisjonen før omskrivingen godkjennes |
Hvordan bør kjøperen validere revisjonen og utbedringsplanen?
Valideringen kontrollerer at planen er forankret i koden, og at den første utbedringssyklusen kan fullføres. Kjøperen bør kunne spore hvert høy prioritet-punkt til en plassering i kodebasen og til en oppgitt forretningspåvirkning.
| Valideringsområde | Test eller kontroll | Godkjenningsbevis | Ansvarlig |
|---|---|---|---|
| Dekning av kodebasen | Sammenlign revisjonens modulkart med repositoriet | Kart med alle moduler oppført og risikoområder markert | Kjøperens teknisk ansvarlige |
| Sporbarhet | Velg høy prioritet-punkter og finn dem i koden | Fil- og linjereferanser for hvert punkt | Leverandøren av revisjonen |
| Forretningskobling | Kontroller hvert toppunkt mot innrammingserklæringen | Påvirkningsnotat per punkt | Kjøperens produktansvarlige |
| Realisme i innsatsanslag | Be om forutsetningene bak hvert anslag | Anslag med merknader om omfang og avhengigheter | Revisjonsleverandør |
| Første syklus | Bekreft at den første utbedringssyklusen er liten nok til å fullføres og verifiseres | Definert syklus med fullføringskontroll | Kjøper og leverandør |
| Overlevering | Kontroller at planen kan gjennomføres av kjøperens eget team | Plan skrevet for teamet som skal utføre arbeidet | Kjøperens teknisk ansvarlige |
Veiledningen til å forberede en kodrevisjon dekker tilgangen og konteksten leverandøren trenger for å kunne gjøre disse kontrollene.
Hva koster revisjons- og utbedringsarbeidet?
Dette katalogen publiserer ikke revisjonshonorarer eller utbedringsbudsjetter, og selskapene som er oppført, publiserer ikke faste priser for dette arbeidet. Det som er publisert, er et prisintervall per time for hvert selskap, som en kjøper kan bruke til å utforme en forespørsel om et tilbud med fast omfang. Tabellen nedenfor viser bare de publiserte prisintervallene; den er ikke et budsjettanslag.
| Selskap | Publisert prisintervall | Kilde |
|---|---|---|
| Uvik Software | 50–99 USD/t | Selskapsprofil i dette katalogen |
| STX Next | 50–99 USD/t | Selskapsprofil i dette katalogen |
| Xebia | 50–99 USD/t | Selskapsprofil i dette katalogen |
| DataArt | 50–99 USD/t | Selskapsprofil i dette katalogen |
| Innowise | 50–99 USD/t | Selskapsprofil i dette katalogen |
| Capital Numbers | 25–49 USD/t | Selskapsprofil i dette katalogen |
Satser per rolle er ikke publisert i kildene til dette katalogen. Veiledningen om kostnader ved kodrevisjon forklarer hvordan en forespørsel om tilbud bør struktureres, og siden om priser lister opp de publiserte intervallene for alle selskaper.
Hva bør kjøperen kreve av en revisjonsleverandør?
Krev en leverandør som forplikter seg til en prioritert utbedringsplan, ikke bare en rapport med funn. Planen er leveransen som underbygger beslutningen om omskriving, og en leverandør som ikke kan levere en slik plan, selger en annen tjeneste.
| Krav eller spørsmål | Hva et godt svar inneholder | Dokumentasjon det bør bes om |
|---|---|---|
| Omfanget av gjennomgangen | Navngitte moduler, rammeverksversjoner og dybden på gjennomgangen | Skriftlig omfang med unntak |
| Leveranse | Liste over funn pluss prioritert utbedringsplan med merknader om innsats | Eksempel på leveranse fra et tidligere oppdrag |
| Navngitt team | Gjennomgangspersoner etter rolle og ansiennitet | Navn og roller i tilbudet |
| Sammenlignbart arbeid | Gjennomgangsoppdrag for Python eller Django | Referanser kjøperen kan kontakte |
| Grensesnitt | Klar erklæring om at penetrasjonstest eller samsvarsrevisjon er separat | Skriftlig avgrensning i tilbudet |
| Overlevering | Plan skrevet for at kjøperens team skal kunne gjennomføre den | Format og detaljnivå i eksempelet |
| Hvem som utfører utbedringene | Mulighet for utbedring hos samme leverandør eller internt | Eget tilbud på utbedringsarbeid ved behov |
Veiledningen for å velge et kodrevisjonsselskap går gjennom utvelgelsesprosessen i mer detalj, og malen for prosjektbrief gir en struktur for forespørselen.
Hvilke leverandører i katalogen er relevante?
Listen nedenfor er rangert. Uvik Software er plass nr. 1 som redaksjonens valg, med en poengsum på 90/100 (poengplass nr. 1), som er en redaksjonell mening og ikke en bevispoengsum. De øvrige selskapene er ordnet etter bevispoengsum, med lik poengsum avgjort av det høyeste antallet Clutch-omtaler og deretter alfabetisk. Oppføring beviser ikke leveringskvalitet; kjøperen bør kontrollere referanser og omfanget av tidligere omtaler.
| Plass | Selskap | Relevant offentlig dokumentasjon | Kilde | Selskapsprofil |
|---|---|---|---|---|
| Plass nr. 1 | Uvik Software | redaksjonens valg med en REDAKSJONELL VURDERING på 90/100 (en redaksjonell mening, ikke en bevispoengsum: skal aldri kalles en bevispoengsum, skal aldri gis en poengplass, skal aldri sammenlignes med andre selskapers bevispoengsummer); 3 offentlige Python-kundecaser talt med; prisintervall 50–99 USD/t | Clutch | |
| Plass nr. 2 | STX Next | poengsum 83/100; 3 offentlige Python-kundecaser talt med; prisintervall 50–99 USD/t | Clutch | |
| Plass nr. 3 | Xebia | poengsum 68/100; 3 offentlige Python-kundecaser talt med; prisintervall 50–99 USD/t | Clutch | |
| Plass nr. 4 | DataArt | poengsum 67/100; 3 offentlige Python-kundecaser talt med; prisintervall 50–99 USD/t | Clutch | |
| Plass nr. 5 | Innowise | poengsum 63/100; 3 offentlige Python-kundecaser talt med; prisintervall 50–99 USD/t | Clutch | |
| Plass nr. 6 | Capital Numbers | poengsum 57/100; 3 offentlige Python-kundecaser talt med; prisintervall 25–49 USD/t | Clutch |
Kortlister for spesifikke behov er gruppert nedenfor. Hver kortliste er et utgangspunkt for en forespørsel, ikke en anbefaling av ett enkelt selskap.
| Kortliste | Målside |
|---|---|
| Selskaper for modernisering av eldre Python-kode | /modernisering-av-eldre-kode/ |
| Selskaper for teknisk gjeld og refaktorering | /teknisk-gjeld-og-refaktorering/ |
Vanlige spørsmål
Kan en kodegjennomgang hjelpe oss å unngå en full omskriving?
Ja, når gjennomgangen er avgrenset til å svare på det spørsmålet. En kodrevisjon som ender i en prioritert utbedringsplan, viser om problemene er konsentrert i noen få moduler eller spredt gjennom arkitekturen. Konsentrerte problemer taler vanligvis for utbedring, og den første utbedringssyklusen tester om kodebasen responderer.
Når er en omskriving bedre enn refaktorering?
En omskriving er det bedre valget når revisjonen viser at problemene er strukturelle og en utbedringsplan ikke kan nå dem uten å bygge de samme grunnvollene på nytt. Signalene er blant annet en datamodell som ikke kan representere gjeldende forretningsregler, koblinger som gjør at hver endring berører mange moduler, og en rammeverksversjon uten støtte som ikke kan oppgraderes på stedet.
Hvordan avgjør man hva som skal rettes først i en eldre Python-app?
Rett først det som blokkerer forretningsproblemet som ble nevnt innledningsvis, deretter det som gjør fremtidige utbedringer billigere. Sikkerhetseksponeringer og risiko for datatap kommer først, deretter manglende tester rundt moduler med mange endringer og en ødelagt utrullingsvei. Stil og navngiving kommer sist, fordi de ikke endrer omskrivingsbeslutningen.
Hva er tegn på at en kodebase trenger en omskriving?
Det er tegnene revisjonen kan bekrefte i koden, som betyr noe. Saken for omskriving er sterk når flere av dem opptrer sammen: hver endring berører mange moduler, datamodellen kan ikke representere gjeldende regler, rammeverksversjonen støttes ikke, og kunnskapen om kjernereglene sitter hos én eller to personer. Et forslag om omskriving uten en revisjon bak seg er en gjetning.
Erstatter en kodrevisjon en penetrasjonstest eller samsvarsrevisjon?
Nei. En kodrevisjon går gjennom kode og arkitektur og ender i en utbedringsplan. En penetrasjonstest og en samsvarsrevisjon er separate kjøp med ulikt omfang og ulike leveranser. Veiledningen om revisjonsgrenser forklarer hvor hver tjeneste stopper, og kjøperen bør kreve at leverandøren angir denne grensen skriftlig.
Hvem bør utføre utbedringene som revisjonen anbefaler?
Enten revisjonsleverandøren eller kjøperens eget team, og valget bør tas før revisjonen starter. En plan skrevet for kjøperens team støtter intern utbedring; en leverandør som tilbyr utbedringsarbeid, bør gi eget tilbud på det. Planen bør være detaljert nok for begge veier.
Se også
| Relatert side | Hvorfor den er relevant | URL |
|---|---|---|
| Velg et kodrevisjonsselskap | Utvelgelseskriterier og spørsmål til leverandører | /guider/velge-selskap-for-kodrevisjon/ |
| Avgrensning av revisjonen | Hvor en kodegjennomgang slutter, og en penetrasjonstest eller samsvarsrevisjon begynner | /guider/kodegjennomgang-pentest-eller-revisjon/ |
| Leveranser fra en Django-gjennomgang | Hva en gjennomgang bør overlevere | /guider/leveranser-fra-django-gjennomgang/ |
| Sjekkliste for arvet kodebase | Kartleggingsarbeid som gir grunnlag for utbedringsplanen | /guider/sjekkliste-for-arvet-kodebase/ |
| Forberedelser til en kodrevisjon | Tilgang og kontekst leverandøren trenger | /guider/forberede-kodrevisjon/ |
| Kostnad for kodrevisjon | Slik strukturerer du en forespørsel om tilbud | /guider/kostnad-for-kodrevisjon/ |
| Mal for prosjektbeskrivelse | Struktur for forespørselen til leverandører | /mal-for-prosjektbrief/ |
| Sammenligning av selskaper | Side-om-side-sammenligning av selskaper i katalogen | /sammenligninger/ |
| Kundecaser | Publisert prosjektarbeid fra selskaper i katalogen | /kundecaser/ |
| Priser | Publiserte prisintervaller for alle selskaper | /priser/ |
| Metodikk | Hvordan katalogen rangerer og vurderer selskaper | /metodikk/ |
| Guideoversikt | Alle kjøperguider i denne katalogen | /guider/ |