From ab1fceda052d355b5dc0d9911e5d03de45fd320e Mon Sep 17 00:00:00 2001 From: Paul Mars Date: Tue, 19 Sep 2023 09:05:47 +0200 Subject: [PATCH 01/13] Add readMetadataJSON/writeMetadataJSON These functions replace the gob encoding of the stateMachine. --- go.mod | 1 + go.sum | 65 +-------------------- internal/statemachine/classic.go | 2 +- internal/statemachine/snap.go | 2 +- internal/statemachine/state_machine.go | 79 +++++++++++++++++++++++--- 5 files changed, 76 insertions(+), 73 deletions(-) diff --git a/go.mod b/go.mod index 0abd4f53..b930f90e 100644 --- a/go.mod +++ b/go.mod @@ -5,6 +5,7 @@ go 1.18 require ( github.com/diskfs/go-diskfs v0.0.0-20211104185512-274de576a1a5 github.com/go-git/go-git/v5 v5.4.2 + github.com/google/go-cmp v0.5.9 github.com/google/uuid v1.3.0 github.com/invopop/jsonschema v0.4.0 github.com/jessevdk/go-flags v1.5.1-0.20210607101731-3927b71304df diff --git a/go.sum b/go.sum index 341d5c22..b997aae2 100644 --- a/go.sum +++ b/go.sum @@ -5,7 +5,6 @@ github.com/ProtonMail/go-crypto v0.0.0-20210428141323-04723f9f07d7 h1:YoJbenK9C6 github.com/ProtonMail/go-crypto v0.0.0-20210428141323-04723f9f07d7/go.mod h1:z4/9nQmJSSwwds7ejkxaJwO37dru3geImFUdJlaLzQo= github.com/acomagu/bufpipe v1.0.3 h1:fxAGrHZTgQ9w5QqVItgzwj235/uYZYgbXitB+dLupOk= github.com/acomagu/bufpipe v1.0.3/go.mod h1:mxdxdup/WdsKVreO5GpW4+M/1CE2sMG4jeGJ2sYmHc4= -github.com/alexkohler/nakedret v1.0.1/go.mod h1:FIP5ubTIqmK2D35Xct6bjnYc4O027gqCYLqXLQM4xuY= github.com/anmitsu/go-shlex v0.0.0-20161002113705-648efa622239 h1:kFOfPq6dUM1hTo4JG6LR5AXSUEsOjtdm0kw0FtQtMJA= github.com/anmitsu/go-shlex v0.0.0-20161002113705-648efa622239/go.mod h1:2FmKhYUyUczH0OGQWaF5ceTx0UBShxjsH6f8oGKYe2c= github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio= @@ -49,15 +48,14 @@ github.com/godbus/dbus v0.0.0-20190726142602-4481cbc300e2 h1:ZpnhV/YsD2/4cESfV5+ github.com/godbus/dbus v0.0.0-20190726142602-4481cbc300e2/go.mod h1:bBOAhwG1umN6/6ZUMtDFBMQR8jRg9O75tm9K00oMsK4= github.com/google/go-cmp v0.2.1-0.20190312032427-6f77996f0c42/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= -github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU= github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38= +github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I= github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= -github.com/gorilla/mux v1.7.4-0.20190701202633-d83b6ffe499a/go.mod h1:1lud6UwP+6orDFRuTfBEV8e9/aOM/c4fVVCaMa2zaAs= github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI= github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So= -github.com/gvalkov/golang-evdev v0.0.0-20191114124502-287e62b94bcb/go.mod h1:SAzVFKCRezozJTGavF3GX8MBUruETCqzivVLYiywouA= github.com/iancoleman/orderedmap v0.0.0-20190318233801-ac98e3ecb4b0 h1:i462o439ZjprVSFSZLZxcsoAe592sZB1rci2Z8j4wdk= github.com/iancoleman/orderedmap v0.0.0-20190318233801-ac98e3ecb4b0/go.mod h1:N0Wam8K1arqPXNWjMo21EXnBPOPp36vB07FNRdD2geA= github.com/imdario/mergo v0.3.12 h1:b6R2BslTbIEToALKP7LxUvijTsNI9TAe80pLWN2g/HU= @@ -77,7 +75,6 @@ github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxv github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI= github.com/kr/pretty v0.2.2-0.20200810074440-814ac30b4b18 h1:fth7xdJYakAjo/XH38edyXuBEqYGJ8Me0RPolN1ZiQE= -github.com/kr/pretty v0.2.2-0.20200810074440-814ac30b4b18/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI= github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= @@ -86,10 +83,8 @@ github.com/matryer/is v1.2.0 h1:92UTHpy8CDwaJ08GqLDzhhuixiBUUD1p3AU6PHddz4A= github.com/matryer/is v1.2.0/go.mod h1:2fLPjFQM9rhQ15aVEtbuwhJinnOqrmgXPNdZsdwlWXA= github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG+4E0Y= github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0= -github.com/mvo5/goconfigparser v0.0.0-20200803085309-72e476556adb/go.mod h1:xmt4k1xLDl8Tdan+0S/jmMK2uSUBSzTc18+5GN5Vea8= github.com/mvo5/goconfigparser v0.0.0-20201015074339-50f22f44deb5 h1:IUtr2a2HkY+0BPb4bz7t7+p26kmp366dLSkuAodXE10= github.com/mvo5/goconfigparser v0.0.0-20201015074339-50f22f44deb5/go.mod h1:xmt4k1xLDl8Tdan+0S/jmMK2uSUBSzTc18+5GN5Vea8= -github.com/mvo5/libseccomp-golang v0.9.1-0.20180308152521-f4de83b52afb/go.mod h1:RduRpSkQHOCvZTbGgT/NJUGjFBFkYlVedimxssQ64ag= github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno= github.com/pierrec/lz4 v2.3.0+incompatible h1:CZzRn4Ut9GbUkHlQ7jqBXeZQV41ZSKWFc302ZU6lUTk= github.com/pierrec/lz4 v2.3.0+incompatible/go.mod h1:pdkljMzZIN41W+lC3N2tnIh5sFi+IEE17M5jbnwPHcY= @@ -102,7 +97,6 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/rogpeppe/clock v0.0.0-20190514195947-2896927a307a h1:3QH7VyOaaiUHNrA9Se4YQIRkDTCw1EJls9xTUCaCeRM= github.com/rogpeppe/clock v0.0.0-20190514195947-2896927a307a/go.mod h1:4r5QyqhjIWCcK8DO4KMclc5Iknq5qVBAlbYYzAbUScQ= -github.com/seccomp/libseccomp-golang v0.9.2-0.20220502024300-f57e1d55ea18/go.mod h1:JA8cRccbGaA1s33RQf7Y1+q9gHmZX1yB/z9WDN1C6fg= github.com/sergi/go-diff v1.1.0 h1:we8PVUC3FE2uYfodKH/nBHMSetSfHDR6scGdBi+erh0= github.com/sergi/go-diff v1.1.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM= github.com/sirupsen/logrus v1.4.1/go.mod h1:ni0Sbl8bgC9z8RoU9G6nDWqqs/fq4eDPysMBDgk/93Q= @@ -113,23 +107,9 @@ github.com/snapcore/bolt v1.3.2-0.20210908134111-63c8bfcf7af8/go.mod h1:Z6z3sf12 github.com/snapcore/go-gettext v0.0.0-20191107141714-82bbea49e785/go.mod h1:D3SsWAXK7wCCBZu+Vk5hc1EuKj/L3XN1puEMXTU4LrQ= github.com/snapcore/go-gettext v0.0.0-20201130093759-38740d1bd3d2 h1:nETXPg0CiJrMAwC2gqkcam9BiBWYGvTsSYRfrjOz2Kg= github.com/snapcore/go-gettext v0.0.0-20201130093759-38740d1bd3d2/go.mod h1:D3SsWAXK7wCCBZu+Vk5hc1EuKj/L3XN1puEMXTU4LrQ= -github.com/snapcore/secboot v0.0.0-20230228104443-f41f07c101e1 h1:HANKyba/BJ8iWRlcrkWG1SQt2CY0jPnCj/zO3mcz/WM= -github.com/snapcore/secboot v0.0.0-20230228104443-f41f07c101e1/go.mod h1:72paVOkm4sJugXt+v9ItmnjXgO921D8xqsbH2OekouY= -github.com/snapcore/secboot v0.0.0-20230428184943-be3902241d8a h1:0mHd/TdxsyR6XWqznXRuCHxHltX736XspJlPFSUzHxU= -github.com/snapcore/secboot v0.0.0-20230428184943-be3902241d8a/go.mod h1:72paVOkm4sJugXt+v9ItmnjXgO921D8xqsbH2OekouY= github.com/snapcore/secboot v0.0.0-20230623151406-4d331d24f830 h1:SCJ9Uiekv6uMqzMGP50Y0KBxkLP7IzPW35aI3Po6iyM= github.com/snapcore/secboot v0.0.0-20230623151406-4d331d24f830/go.mod h1:72paVOkm4sJugXt+v9ItmnjXgO921D8xqsbH2OekouY= github.com/snapcore/snapd v0.0.0-20201005140838-501d14ac146e/go.mod h1:3xrn7QDDKymcE5VO2rgWEQ5ZAUGb9htfwlXnoel6Io8= -github.com/snapcore/snapd v0.0.0-20230328104537-3d627c740f16 h1:IP79eb5PkZe7/f6yXXqVpac+QYzKwbn/kEPIHqz6Vtc= -github.com/snapcore/snapd v0.0.0-20230328104537-3d627c740f16/go.mod h1:wGun6rbVA2uJSMckvjQsDQsPEieJ1dY6o3nrYWwHmxE= -github.com/snapcore/snapd v0.0.0-20230417120123-30b11fae293a h1:CxbDPBQwGEw/BKPZUo7bF77JZoIhVLNDIi1O+JvNH1w= -github.com/snapcore/snapd v0.0.0-20230417120123-30b11fae293a/go.mod h1:cuS/HJElAZt0mJmpWdeiAtZnc6l1lDXfFK6HpJaXrx4= -github.com/snapcore/snapd v0.0.0-20230501100657-635f08b765bb h1:5a83ZsjTD77fKfpvDFeBT97MSO2f6dTC6SKwEDgRmXU= -github.com/snapcore/snapd v0.0.0-20230501100657-635f08b765bb/go.mod h1:5UPR3Qk1W3C80VeYCh0CU0Id/tRJs2c3jvrTaG1/dhU= -github.com/snapcore/snapd v0.0.0-20230801133100-22e1eb37ca26 h1:fvFTZ03lGBeXFmgn/V2ugNM7aEDU68EvwYdsKUTwuBk= -github.com/snapcore/snapd v0.0.0-20230801133100-22e1eb37ca26/go.mod h1:M+wSEB8eBfffw7I69nDtilqKfbdkmCNbtXY1wMJV1v0= -github.com/snapcore/snapd v0.0.0-20230906082059-1def7c6bfd02 h1:LvYq7FYSFOYCBWMJovo6Mvt2N8GHTHLSyS/9rIfUxYs= -github.com/snapcore/snapd v0.0.0-20230906082059-1def7c6bfd02/go.mod h1:M+wSEB8eBfffw7I69nDtilqKfbdkmCNbtXY1wMJV1v0= github.com/snapcore/snapd v0.0.0-20230918083329-3a169c3795c7 h1:ry7HJmraU4aPeXglrpZyLLQ4rg8ZW5y6Bs5bk+tZ/tc= github.com/snapcore/snapd v0.0.0-20230918083329-3a169c3795c7/go.mod h1:M+wSEB8eBfffw7I69nDtilqKfbdkmCNbtXY1wMJV1v0= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= @@ -142,8 +122,6 @@ github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5Cc github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/ulikunitz/xz v0.5.10 h1:t92gobL9l3HE202wg3rlk19F6X+JOxl9BBrCCMYEYd8= github.com/ulikunitz/xz v0.5.10/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14= -github.com/valentindavid/snapd v0.0.0-20230906104351-371cc172902e h1:YpAiE+7sELcD417kU/BuvUBS6qC6rK+xZvi9nsmSvks= -github.com/valentindavid/snapd v0.0.0-20230906104351-371cc172902e/go.mod h1:M+wSEB8eBfffw7I69nDtilqKfbdkmCNbtXY1wMJV1v0= github.com/xanzy/ssh-agent v0.3.0 h1:wUMzuKtKilRgBAD1sUb8gOwwRr2FGoBVumcjoOACClI= github.com/xanzy/ssh-agent v0.3.0/go.mod h1:3s9xbODqPuuhK9JV1R321M/FlMZSBvE5aY6eAcqrDh0= github.com/xeipuuv/gojsonpointer v0.0.0-20180127040702-4e3ac2762d5f h1:J9EGpcZtP0E/raorCMxlFGSTBrsSlaDGf3jU/qvAE2c= @@ -152,7 +130,6 @@ github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 h1:EzJWgHo github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415/go.mod h1:GwrjFmJcFw6At/Gs6z4yjiIwzuJ1/+UwLxMQDVQXShQ= github.com/xeipuuv/gojsonschema v1.2.0 h1:LhYJRs+L4fBtjZUfuSZIKGeVu0QRy8e5Xi7D17UxZ74= github.com/xeipuuv/gojsonschema v1.2.0/go.mod h1:anYRn/JVcOK2ZgGU+IjEV4nwlhoK5sQluxsYJ78Id3Y= -github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= go.mozilla.org/pkcs7 v0.0.0-20200128120323-432b2356ecb1 h1:A/5uWzF44DlIgdm/PQFwfMkW0JX+cIcQi/SwLAmZP5M= go.mozilla.org/pkcs7 v0.0.0-20200128120323-432b2356ecb1/go.mod h1:SNgMg+EgDFwmvSmLRTNKC5fegJjB7v23qTQ0XLGUNHk= golang.org/x/crypto v0.0.0-20190219172222-a4c6cb3142f2/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= @@ -161,26 +138,14 @@ golang.org/x/crypto v0.0.0-20190611184440-5c40567a22f8/go.mod h1:yigFU9vqHzYiE8U golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20210322153248-0c34fe9e7dc2/go.mod h1:T9bdIzuCu7OtxOm1hfPfRQxPLYneinmdGuTeoZ9dtd4= golang.org/x/crypto v0.0.0-20210421170649-83a5a9bb288b/go.mod h1:T9bdIzuCu7OtxOm1hfPfRQxPLYneinmdGuTeoZ9dtd4= -golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/crypto v0.0.0-20220829220503-c86fa9a7ed90 h1:Y/gsMcFOcR+6S6f3YeMKl5g+dZMEWqcz5Czj/GWYbkM= golang.org/x/crypto v0.0.0-20220829220503-c86fa9a7ed90/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= -golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= -golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= -golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20201002202402-0a1ea396d57c/go.mod h1:iQL9McJNjoIa5mjH6nYTCTZXUN6RP+XW3eib7Ya3XcI= golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20210326060303-6b1517762897/go.mod h1:uSPa2vr4CLtc/ILN5odXGNXS6mhrKVzTaCXzk9m6W3k= -golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= -golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= -golang.org/x/net v0.0.0-20220826154423-83b083e8dc8b h1:ZmngSVLe/wycRns9MKikG9OWIEjGcGAkacif7oYQaUY= -golang.org/x/net v0.0.0-20220826154423-83b083e8dc8b/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk= -golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= golang.org/x/net v0.9.0 h1:aWJ/m6xSmxWBx+V0XRHTlrYrPG56jKsLdTFmsSsCzOM= golang.org/x/net v0.9.0/go.mod h1:d48xBJpPfHeWQsugry2m+kC02ZBRGRgulfHnEXEuWns= -golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20181021155630-eda9bb28ed51/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= @@ -194,35 +159,16 @@ golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210320140829-1e4c9ba3b0c4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210324051608-47abb6519492/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210502180810-71e4cd670f79/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20220728004956-3c1f35247d10/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20220829200755-d48e67d00261 h1:v6hYoSR9T5oet+pMXwUWkbiVqx/63mlHjefrHmxwfeY= -golang.org/x/sys v0.0.0-20220829200755-d48e67d00261/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.7.0 h1:3jlCCIQZPdOYu1h8BkNvLz8Kgwtae2cagcG/VamtZRU= golang.org/x/sys v0.7.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= -golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 h1:JGgROgKl9N8DuW20oFS5gxc+lE67/N3FcwmBPMe7ArY= -golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= -golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= golang.org/x/term v0.7.0 h1:BEvjmm5fURWqcfbSKTdpkDXYBrUS1c0m8agp14W48vQ= golang.org/x/term v0.7.0/go.mod h1:P32HKFT3hSsZrRxla30E9HqToFYAQPCMs/zFMBUFqPY= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= -golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= -golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk= -golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= -golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= -golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= +golang.org/x/text v0.9.0 h1:2sjJmO8cDvYveuX97RDLsxlyUxLl+GHoLxBiRdHllBE= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= -golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= -golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= -golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= -golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= @@ -236,17 +182,14 @@ gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntN gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= gopkg.in/djherbis/times.v1 v1.2.0 h1:UCvDKl1L/fmBygl2Y7hubXCnY7t4Yj46ZrBFNUipFbM= gopkg.in/djherbis/times.v1 v1.2.0/go.mod h1:AQlg6unIsrsCEdQYhTzERy542dz6SFdQFZFv6mUY0P8= -gopkg.in/macaroon.v1 v1.0.0-20150121114231-ab3940c6c165/go.mod h1:PABpHZvxAbIuSYTPWJdQsNu0mtx+HX/1NIm3IT95IX0= gopkg.in/macaroon.v1 v1.0.0 h1:BmexIS8QyY02i0uoeXwrtlH8vCS/Rmxq9uzOy4qQvk8= gopkg.in/macaroon.v1 v1.0.0/go.mod h1:KeG3in9Jb7Z3RNA/PFngm+mISBo0Q0O9KQeF958zuoQ= -gopkg.in/mgo.v2 v2.0.0-20180704144907-a7e2c1d573e1/go.mod h1:yeKp02qBN3iKW1OzL3MGk2IdtZzaj7SFntXj72NppTA= gopkg.in/mgo.v2 v2.0.0-20190816093944-a6b53ec6cb22 h1:VpOs+IwYnYBaFnrNAeB8UUWtL3vEUnzSCL1nVjPhqrw= gopkg.in/mgo.v2 v2.0.0-20190816093944-a6b53ec6cb22/go.mod h1:yeKp02qBN3iKW1OzL3MGk2IdtZzaj7SFntXj72NppTA= gopkg.in/retry.v1 v1.0.3 h1:a9CArYczAVv6Qs6VGoLMio99GEs7kY9UzSF9+LD+iGs= gopkg.in/retry.v1 v1.0.3/go.mod h1:FJkXmWiMaAo7xB+xhvDF59zhfjDWyzmyAxiT4dB688g= gopkg.in/tomb.v2 v2.0.0-20161208151619-d5d1b5820637 h1:yiW+nvdHb9LVqSHQBXfZCieqV4fzYhNBql77zY0ykqs= gopkg.in/tomb.v2 v2.0.0-20161208151619-d5d1b5820637/go.mod h1:BHsqpu/nsuzkT5BpiH1EMZPLyqSMM8JbIavyFACoFNk= -gopkg.in/tylerb/graceful.v1 v1.2.15/go.mod h1:yBhekWvR20ACXVObSSdD3u6S9DeSylanL2PAbAC/uJ8= gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME= gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI= gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= @@ -255,8 +198,6 @@ gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY= gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= -gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo= -gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= maze.io/x/crypto v0.0.0-20190131090603-9b94c9afe066 h1:UrD21H1Ue5Nl8f2x/NQJBRdc49YGmla3mRStinH8CCE= diff --git a/internal/statemachine/classic.go b/internal/statemachine/classic.go index 7a841780..c9a82d39 100644 --- a/internal/statemachine/classic.go +++ b/internal/statemachine/classic.go @@ -48,7 +48,7 @@ func (classicStateMachine *ClassicStateMachine) Setup() error { } // if --resume was passed, figure out where to start - if err := classicStateMachine.readMetadata(); err != nil { + if err := classicStateMachine.readMetadataJSON(metadataStateFile); err != nil { return err } diff --git a/internal/statemachine/snap.go b/internal/statemachine/snap.go index 8893a2a0..cb7d0b81 100644 --- a/internal/statemachine/snap.go +++ b/internal/statemachine/snap.go @@ -48,7 +48,7 @@ func (snapStateMachine *SnapStateMachine) Setup() error { } // if --resume was passed, figure out where to start - if err := snapStateMachine.readMetadata(); err != nil { + if err := snapStateMachine.readMetadataJSON(metadataStateFile); err != nil { return err } diff --git a/internal/statemachine/state_machine.go b/internal/statemachine/state_machine.go index 8dbdd5cc..f8728b27 100644 --- a/internal/statemachine/state_machine.go +++ b/internal/statemachine/state_machine.go @@ -30,6 +30,10 @@ import ( "gopkg.in/yaml.v2" ) +const ( + metadataStateFile = "ubuntu-image.json" +) + // define some functions that can be mocked by test cases var gadgetLayoutVolume = gadget.LayoutVolume var gadgetNewMountedFilesystemWriter = gadget.NewMountedFilesystemWriter @@ -329,11 +333,13 @@ func (stateMachine *StateMachine) postProcessGadgetYaml() error { return nil } -// readMetadata reads info about a partial state machine from disk -func (stateMachine *StateMachine) readMetadata() error { +// readMetadataGob reads info about a partial state machine encoded as gob from disk +func (stateMachine *StateMachine) readMetadataGob() error { // handle the resume case - if stateMachine.stateMachineFlags.Resume { - // open the ubuntu-image.gob file and determine the state + if !stateMachine.stateMachineFlags.Resume { + return nil + } + // open the ubuntu-image.gob file and load the state var partialStateMachine = new(StateMachine) gobfilePath := filepath.Join(stateMachine.stateMachineFlags.WorkDir, "ubuntu-image.gob") gobfile, err := os.Open(gobfilePath) @@ -341,32 +347,65 @@ func (stateMachine *StateMachine) readMetadata() error { return fmt.Errorf("error reading metadata file: %s", err.Error()) } defer gobfile.Close() + dec := gob.NewDecoder(gobfile) err = dec.Decode(&partialStateMachine) if err != nil { return fmt.Errorf("failed to parse metadata file: %s", err.Error()) } + + return stateMachine.loadState(partialStateMachine) +} + +// readMetadataJSON reads info about a partial state machine encoded as JSON from disk +func (stateMachine *StateMachine) readMetadataJSON(metadataFile string) error { + if !stateMachine.stateMachineFlags.Resume { + return nil + } + // open the ubuntu-image.json file and load the state + var partialStateMachine = &StateMachine{} + jsonfilePath := filepath.Join(stateMachine.stateMachineFlags.WorkDir, metadataFile) + jsonfile, err := os.ReadFile(jsonfilePath) + if err != nil { + return fmt.Errorf("error reading metadata file: %s", err.Error()) + } + + err = json.Unmarshal(jsonfile, partialStateMachine) + if err != nil { + return fmt.Errorf("failed to parse metadata file: %s", err.Error()) + } + + return stateMachine.loadState(partialStateMachine) +} + +func (stateMachine *StateMachine) loadState(partialStateMachine *StateMachine) error { + stateMachine.StepsTaken = partialStateMachine.StepsTaken + + if stateMachine.StepsTaken > len(stateMachine.states) { + return fmt.Errorf("invalid steps taken count (%d). The state machine only have %d steps", stateMachine.StepsTaken, len(stateMachine.states)) + } + + // delete all of the stateFuncs that have already run + stateMachine.states = stateMachine.states[stateMachine.StepsTaken:] + stateMachine.CurrentStep = partialStateMachine.CurrentStep - stateMachine.StepsTaken = partialStateMachine.StepsTaken stateMachine.GadgetInfo = partialStateMachine.GadgetInfo stateMachine.YamlFilePath = partialStateMachine.YamlFilePath stateMachine.ImageSizes = partialStateMachine.ImageSizes stateMachine.RootfsSize = partialStateMachine.RootfsSize stateMachine.IsSeeded = partialStateMachine.IsSeeded stateMachine.VolumeOrder = partialStateMachine.VolumeOrder + stateMachine.SectorSize = partialStateMachine.SectorSize stateMachine.tempDirs.rootfs = filepath.Join(stateMachine.stateMachineFlags.WorkDir, "root") stateMachine.tempDirs.unpack = filepath.Join(stateMachine.stateMachineFlags.WorkDir, "unpack") stateMachine.tempDirs.volumes = filepath.Join(stateMachine.stateMachineFlags.WorkDir, "volumes") - // delete all of the stateFuncs that have already run - stateMachine.states = stateMachine.states[stateMachine.StepsTaken:] - // due to https://github.com/golang/go/issues/10415 we need to set back the volume // structs we reset before encoding (see writeMetadata()) if stateMachine.GadgetInfo != nil { gadget.SetEnclosingVolumeInStructs(stateMachine.GadgetInfo.Volumes) } - } + return nil } @@ -393,6 +432,28 @@ func (stateMachine *StateMachine) writeMetadata() error { return nil } +// writeMetadataJSON writes the state machine info to disk, encoded as JSON. This will be used when resuming a +// partial state machine run +func (stateMachine *StateMachine) writeMetadataJSON() error { + jsonfilePath := filepath.Join(stateMachine.stateMachineFlags.WorkDir, "ubuntu-image.json") + jsonfile, err := os.OpenFile(jsonfilePath, os.O_CREATE|os.O_WRONLY, 0644) + if err != nil && !os.IsExist(err) { + return fmt.Errorf("error opening JSON metadata file for writing: %s", jsonfilePath) + } + defer jsonfile.Close() + + b, err := json.Marshal(stateMachine) + if err != nil { + return fmt.Errorf("failed to JSON encode metadata: %w", err) + } + + _, err = jsonfile.Write(b) + if err != nil { + return fmt.Errorf("failed to write metadata to file: %w", err) + } + return nil +} + // handleContentSizes ensures that the sizes of the partitions are large enough and stores // safe values in the stateMachine struct for use during make_image func (stateMachine *StateMachine) handleContentSizes(farthestOffset quantity.Offset, volumeName string) { From 46fa4c95ab5fcfd868c3d52fd43a8b5213ef288f Mon Sep 17 00:00:00 2001 From: Paul Mars Date: Tue, 19 Sep 2023 09:06:29 +0200 Subject: [PATCH 02/13] Test readMetadataJSON A new testing helper is also added to ease object comparison. --- internal/helper/asserter.go | 10 ++ internal/statemachine/state_machine_test.go | 140 +++++++++++++++++- .../testdata/metadata/invalid_format.json | 7 + .../testdata/metadata/successful_read.json | 59 ++++++++ .../testdata/metadata/too_many_steps.json | 59 ++++++++ 5 files changed, 273 insertions(+), 2 deletions(-) create mode 100644 internal/statemachine/testdata/metadata/invalid_format.json create mode 100644 internal/statemachine/testdata/metadata/successful_read.json create mode 100644 internal/statemachine/testdata/metadata/too_many_steps.json diff --git a/internal/helper/asserter.go b/internal/helper/asserter.go index bbf9d6d5..3ae7118e 100644 --- a/internal/helper/asserter.go +++ b/internal/helper/asserter.go @@ -4,6 +4,8 @@ import ( "runtime/debug" "strings" "testing" + + "github.com/google/go-cmp/cmp" ) // Asserter for testing purposes @@ -37,3 +39,11 @@ func (asserter *Asserter) AssertErrContains(err error, errString string) { } } } + +// AssertEqual asserts that two objects are equal using go-cmp +func (asserter *Asserter) AssertEqual(want, got interface{}, cmpOpts ...cmp.Option) { + diff := cmp.Diff(want, got, cmpOpts...) + if want != nil && diff != "" { + asserter.Errorf("mismatch (-want +got):\n%s", diff) + } +} diff --git a/internal/statemachine/state_machine_test.go b/internal/statemachine/state_machine_test.go index da84e21d..269c347a 100644 --- a/internal/statemachine/state_machine_test.go +++ b/internal/statemachine/state_machine_test.go @@ -15,6 +15,8 @@ import ( "github.com/canonical/ubuntu-image/internal/helper" diskfs "github.com/diskfs/go-diskfs" "github.com/diskfs/go-diskfs/disk" + "github.com/google/go-cmp/cmp" + "github.com/google/go-cmp/cmp/cmpopts" "github.com/invopop/jsonschema" "github.com/snapcore/snapd/gadget" "github.com/snapcore/snapd/gadget/quantity" @@ -24,6 +26,10 @@ import ( "github.com/xeipuuv/gojsonschema" ) +const ( + testDataDir = "testdata" +) + var testDir = "ubuntu-image-0615c8dd-d3af-4074-bfcb-c3d3c8392b06" // for tests where we don't want to run actual states @@ -49,6 +55,10 @@ var allTestStates = []stateFunc{ {"finish", (*StateMachine).finish}, } +func ptrToOffset(offset quantity.Offset) *quantity.Offset { + return &offset +} + // define some mocked versions of go package functions func mockCopyBlob([]string) error { return fmt.Errorf("Test Error") @@ -267,7 +277,7 @@ func (TestStateMachine *testStateMachine) Setup() error { } // if --resume was passed, figure out where to start - if err := TestStateMachine.readMetadata(); err != nil { + if err := TestStateMachine.readMetadataGob(); err != nil { return err } @@ -438,7 +448,7 @@ func TestFailedMetadataParse(t *testing.T) { stateMachine.stateMachineFlags.Resume = true stateMachine.stateMachineFlags.WorkDir = "testdata" - err := stateMachine.readMetadata() + err := stateMachine.readMetadataGob() asserter.AssertErrContains(err, "failed to parse metadata file") }) } @@ -790,3 +800,129 @@ func TestFailedPostProcessGadgetYaml(t *testing.T) { asserter.AssertErrContains(err, "disallowed for security purposes") }) } + +func TestStateMachine_readMetadataJSON(t *testing.T) { + type args struct { + metadataFile string + } + + cmpOpts := []cmp.Option{ + cmp.AllowUnexported( + StateMachine{}, + gadget.Info{}, + temporaryDirectories{}, + stateFunc{}, + ), + cmpopts.IgnoreFields(stateFunc{}, "function"), + cmpopts.IgnoreFields(gadget.VolumeStructure{}, "EnclosingVolume"), + } + + testCases := []struct { + name string + wantStateMachine *StateMachine + args args + shouldPass bool + expectedError string + }{ + { + name: "successful read", + args: args{ + metadataFile: "successful_read.json", + }, + wantStateMachine: &StateMachine{ + stateMachineFlags: &commands.StateMachineOpts{ + Resume: true, + WorkDir: filepath.Join(testDataDir, "metadata"), + }, + CurrentStep: "", + StepsTaken: 2, + YamlFilePath: "/tmp/ubuntu-image-2329554237/unpack/gadget/meta/gadget.yaml", + IsSeeded: true, + SectorSize: quantity.Size(512), + RootfsSize: quantity.Size(775915520), + states: allTestStates[2:], + GadgetInfo: &gadget.Info{ + Volumes: map[string]*gadget.Volume{ + "pc": { + Schema: "gpt", + Bootloader: "grub", + Structure: []gadget.VolumeStructure{ + { + Name: "mbr", + Offset: ptrToOffset(quantity.Offset(quantity.Size(0))), + MinSize: quantity.Size(440), + Size: quantity.Size(440), + Role: "mbr", + Type: "mbr", + Content: []gadget.VolumeContent{ + { + Image: "pc-boot.img", + }, + }, + Update: gadget.VolumeUpdate{ + Edition: 1, + }, + }, + }, + }, + }, + }, + ImageSizes: map[string]quantity.Size{"pc": 3155165184}, + VolumeOrder: []string{"pc"}, + VolumeNames: nil, + tempDirs: temporaryDirectories{ + rootfs: filepath.Join(testDataDir, "metadata", "root"), + unpack: filepath.Join(testDataDir, "metadata", "unpack"), + volumes: filepath.Join(testDataDir, "metadata", "volumes"), + }, + }, + shouldPass: true, + }, + { + name: "invalid format", + args: args{ + metadataFile: "invalid_format.json", + }, + wantStateMachine: nil, + shouldPass: false, + expectedError: "failed to parse metadata file", + }, + { + name: "missing state file", + args: args{ + metadataFile: "inexistent.json", + }, + wantStateMachine: nil, + shouldPass: false, + expectedError: "error reading metadata file", + }, + { + name: "state file with too many steps", + args: args{ + metadataFile: "too_many_steps.json", + }, + wantStateMachine: nil, + shouldPass: false, + expectedError: "invalid steps taken count", + }, + } + for _, tc := range testCases { + t.Run(tc.name, func(t *testing.T) { + asserter := helper.Asserter{T: t} + gotStateMachine := &StateMachine{ + stateMachineFlags: &commands.StateMachineOpts{ + Resume: true, + WorkDir: filepath.Join(testDataDir, "metadata"), + }, + states: allTestStates, + } + + err := gotStateMachine.readMetadataJSON(tc.args.metadataFile) + if tc.shouldPass { + asserter.AssertEqual(tc.wantStateMachine, gotStateMachine, cmpOpts...) + } else { + asserter.AssertErrContains(err, tc.expectedError) + } + }) + } +} diff --git a/internal/statemachine/testdata/metadata/invalid_format.json b/internal/statemachine/testdata/metadata/invalid_format.json new file mode 100644 index 00000000..0cf5d979 --- /dev/null +++ b/internal/statemachine/testdata/metadata/invalid_format.json @@ -0,0 +1,7 @@ +{ + "CurrentStep": "", + "StepsTaken": 2, + "YamlFilePath": "/tmp/ubuntu-image-2329554237/unpack/gadget/meta/gadget.yaml", + "IsSeeded": true, + "SectorSize": 512, + "RootfsSize": 775915520, diff --git a/internal/statemachine/testdata/metadata/successful_read.json b/internal/statemachine/testdata/metadata/successful_read.json new file mode 100644 index 00000000..8413dbb9 --- /dev/null +++ b/internal/statemachine/testdata/metadata/successful_read.json @@ -0,0 +1,59 @@ +{ + "CurrentStep": "", + "StepsTaken": 2, + "YamlFilePath": "/tmp/ubuntu-image-2329554237/unpack/gadget/meta/gadget.yaml", + "IsSeeded": true, + "SectorSize": 512, + "RootfsSize": 775915520, + "GadgetInfo": { + "Volumes": { + "pc": { + "schema": "gpt", + "bootloader": "grub", + "id": "", + "structure": [ + { + "name": "mbr", + "filesystem-label": "", + "offset": 0, + "offset-write": null, + "min-size": 440, + "size": 440, + "type": "mbr", + "role": "mbr", + "id": "", + "filesystem": "", + "content": [ + { + "source": "", + "target": "", + "image": "pc-boot.img", + "offset": null, + "size": 0, + "unpack": false + } + ], + "update": { + "edition": 1, + "preserve": null + } + } + ] + } + }, + "Defaults": null, + "Connections": null, + "KernelCmdline": { + "Allow": null + } + }, + "ImageSizes": { + "pc": 3155165184 + }, + "VolumeOrder": [ + "pc" + ], + "VolumeNames": { + "pc": "pc.img" + } +} \ No newline at end of file diff --git a/internal/statemachine/testdata/metadata/too_many_steps.json b/internal/statemachine/testdata/metadata/too_many_steps.json new file mode 100644 index 00000000..dd808415 --- /dev/null +++ b/internal/statemachine/testdata/metadata/too_many_steps.json @@ -0,0 +1,59 @@ +{ + "CurrentStep": "", + "StepsTaken": 30, + "YamlFilePath": "/tmp/ubuntu-image-2329554237/unpack/gadget/meta/gadget.yaml", + "IsSeeded": true, + "SectorSize": 512, + "RootfsSize": 775915520, + "GadgetInfo": { + "Volumes": { + "pc": { + "schema": "gpt", + "bootloader": "grub", + "id": "", + "structure": [ + { + "name": "mbr", + "filesystem-label": "", + "offset": 0, + "offset-write": null, + "min-size": 440, + "size": 440, + "type": "mbr", + "role": "mbr", + "id": "", + "filesystem": "", + "content": [ + { + "source": "", + "target": "", + "image": "pc-boot.img", + "offset": null, + "size": 0, + "unpack": false + } + ], + "update": { + "edition": 1, + "preserve": null + } + } + ] + } + }, + "Defaults": null, + "Connections": null, + "KernelCmdline": { + "Allow": null + } + }, + "ImageSizes": { + "pc": 3155165184 + }, + "VolumeOrder": [ + "pc" + ], + "VolumeNames": { + "pc": "pc.img" + } +} \ No newline at end of file From c82465f72e6a259c45335d0c9b7acaaaef01bea4 Mon Sep 17 00:00:00 2001 From: Paul Mars Date: Tue, 19 Sep 2023 09:06:59 +0200 Subject: [PATCH 03/13] Simplify Teardown method --- internal/statemachine/state_machine.go | 66 ++++++++++++-------------- 1 file changed, 31 insertions(+), 35 deletions(-) diff --git a/internal/statemachine/state_machine.go b/internal/statemachine/state_machine.go index f8728b27..85527637 100644 --- a/internal/statemachine/state_machine.go +++ b/internal/statemachine/state_machine.go @@ -340,19 +340,19 @@ func (stateMachine *StateMachine) readMetadataGob() error { return nil } // open the ubuntu-image.gob file and load the state - var partialStateMachine = new(StateMachine) - gobfilePath := filepath.Join(stateMachine.stateMachineFlags.WorkDir, "ubuntu-image.gob") - gobfile, err := os.Open(gobfilePath) - if err != nil { - return fmt.Errorf("error reading metadata file: %s", err.Error()) - } - defer gobfile.Close() + var partialStateMachine = new(StateMachine) + gobfilePath := filepath.Join(stateMachine.stateMachineFlags.WorkDir, "ubuntu-image.gob") + gobfile, err := os.Open(gobfilePath) + if err != nil { + return fmt.Errorf("error reading metadata file: %s", err.Error()) + } + defer gobfile.Close() - dec := gob.NewDecoder(gobfile) - err = dec.Decode(&partialStateMachine) - if err != nil { - return fmt.Errorf("failed to parse metadata file: %s", err.Error()) - } + dec := gob.NewDecoder(gobfile) + err = dec.Decode(&partialStateMachine) + if err != nil { + return fmt.Errorf("failed to parse metadata file: %s", err.Error()) + } return stateMachine.loadState(partialStateMachine) } @@ -388,23 +388,23 @@ func (stateMachine *StateMachine) loadState(partialStateMachine *StateMachine) e // delete all of the stateFuncs that have already run stateMachine.states = stateMachine.states[stateMachine.StepsTaken:] - stateMachine.CurrentStep = partialStateMachine.CurrentStep - stateMachine.GadgetInfo = partialStateMachine.GadgetInfo - stateMachine.YamlFilePath = partialStateMachine.YamlFilePath - stateMachine.ImageSizes = partialStateMachine.ImageSizes - stateMachine.RootfsSize = partialStateMachine.RootfsSize - stateMachine.IsSeeded = partialStateMachine.IsSeeded - stateMachine.VolumeOrder = partialStateMachine.VolumeOrder + stateMachine.CurrentStep = partialStateMachine.CurrentStep + stateMachine.GadgetInfo = partialStateMachine.GadgetInfo + stateMachine.YamlFilePath = partialStateMachine.YamlFilePath + stateMachine.ImageSizes = partialStateMachine.ImageSizes + stateMachine.RootfsSize = partialStateMachine.RootfsSize + stateMachine.IsSeeded = partialStateMachine.IsSeeded + stateMachine.VolumeOrder = partialStateMachine.VolumeOrder stateMachine.SectorSize = partialStateMachine.SectorSize - stateMachine.tempDirs.rootfs = filepath.Join(stateMachine.stateMachineFlags.WorkDir, "root") - stateMachine.tempDirs.unpack = filepath.Join(stateMachine.stateMachineFlags.WorkDir, "unpack") - stateMachine.tempDirs.volumes = filepath.Join(stateMachine.stateMachineFlags.WorkDir, "volumes") - - // due to https://github.com/golang/go/issues/10415 we need to set back the volume - // structs we reset before encoding (see writeMetadata()) - if stateMachine.GadgetInfo != nil { - gadget.SetEnclosingVolumeInStructs(stateMachine.GadgetInfo.Volumes) - } + stateMachine.tempDirs.rootfs = filepath.Join(stateMachine.stateMachineFlags.WorkDir, "root") + stateMachine.tempDirs.unpack = filepath.Join(stateMachine.stateMachineFlags.WorkDir, "unpack") + stateMachine.tempDirs.volumes = filepath.Join(stateMachine.stateMachineFlags.WorkDir, "volumes") + + // due to https://github.com/golang/go/issues/10415 we need to set back the volume + // structs we reset before encoding (see writeMetadata()) + if stateMachine.GadgetInfo != nil { + gadget.SetEnclosingVolumeInStructs(stateMachine.GadgetInfo.Volumes) + } return nil } @@ -501,12 +501,8 @@ func (stateMachine *StateMachine) Run() error { // Teardown handles anything else that needs to happen after the states have finished running func (stateMachine *StateMachine) Teardown() error { - if !stateMachine.cleanWorkDir { - if err := stateMachine.writeMetadata(); err != nil { - return err - } - } else { - stateMachine.cleanup() + if stateMachine.cleanWorkDir { + return stateMachine.cleanup() } - return nil + return stateMachine.writeMetadataJSON() } From db1edc149b759df6e29bd4917bc4e93e3aa49040 Mon Sep 17 00:00:00 2001 From: Paul Mars Date: Tue, 19 Sep 2023 10:31:57 +0200 Subject: [PATCH 04/13] Test writeMetadataJSON --- internal/statemachine/state_machine.go | 6 +- internal/statemachine/state_machine_test.go | 100 ++++++++++++++++++ .../metadata/reference_successful_write.json | 1 + .../testdata/metadata/successful_write.json | 1 + 4 files changed, 105 insertions(+), 3 deletions(-) create mode 100644 internal/statemachine/testdata/metadata/reference_successful_write.json create mode 100644 internal/statemachine/testdata/metadata/successful_write.json diff --git a/internal/statemachine/state_machine.go b/internal/statemachine/state_machine.go index 85527637..d1a6ccf5 100644 --- a/internal/statemachine/state_machine.go +++ b/internal/statemachine/state_machine.go @@ -434,8 +434,8 @@ func (stateMachine *StateMachine) writeMetadata() error { // writeMetadataJSON writes the state machine info to disk, encoded as JSON. This will be used when resuming a // partial state machine run -func (stateMachine *StateMachine) writeMetadataJSON() error { - jsonfilePath := filepath.Join(stateMachine.stateMachineFlags.WorkDir, "ubuntu-image.json") +func (stateMachine *StateMachine) writeMetadataJSON(metadataFile string) error { + jsonfilePath := filepath.Join(stateMachine.stateMachineFlags.WorkDir, metadataFile) jsonfile, err := os.OpenFile(jsonfilePath, os.O_CREATE|os.O_WRONLY, 0644) if err != nil && !os.IsExist(err) { return fmt.Errorf("error opening JSON metadata file for writing: %s", jsonfilePath) @@ -504,5 +504,5 @@ func (stateMachine *StateMachine) Teardown() error { if stateMachine.cleanWorkDir { return stateMachine.cleanup() } - return stateMachine.writeMetadataJSON() + return stateMachine.writeMetadataJSON(metadataStateFile) } diff --git a/internal/statemachine/state_machine_test.go b/internal/statemachine/state_machine_test.go index 269c347a..ab95083e 100644 --- a/internal/statemachine/state_machine_test.go +++ b/internal/statemachine/state_machine_test.go @@ -926,3 +926,103 @@ func TestStateMachine_readMetadataJSON(t *testing.T) { }) } } + +func TestStateMachine_writeMetadataJSON(t *testing.T) { + tests := []struct { + name string + stateMachine *StateMachine + shouldPass bool + expectedError string + }{ + { + name: "successful write", + stateMachine: &StateMachine{ + stateMachineFlags: &commands.StateMachineOpts{ + Resume: true, + WorkDir: filepath.Join(testDataDir, "metadata"), + }, + CurrentStep: "", + StepsTaken: 2, + YamlFilePath: "/tmp/ubuntu-image-2329554237/unpack/gadget/meta/gadget.yaml", + IsSeeded: true, + SectorSize: quantity.Size(512), + RootfsSize: quantity.Size(775915520), + states: allTestStates[2:], + GadgetInfo: &gadget.Info{ + Volumes: map[string]*gadget.Volume{ + "pc": { + Schema: "gpt", + Bootloader: "grub", + Structure: []gadget.VolumeStructure{ + { + Name: "mbr", + Offset: ptrToOffset(quantity.Offset(quantity.Size(0))), + MinSize: quantity.Size(440), + Size: quantity.Size(440), + Role: "mbr", + Type: "mbr", + Content: []gadget.VolumeContent{ + { + Image: "pc-boot.img", + }, + }, + Update: gadget.VolumeUpdate{ + Edition: 1, + }, + }, + }, + }, + }, + }, + ImageSizes: map[string]quantity.Size{"pc": 3155165184}, + VolumeOrder: []string{"pc"}, + VolumeNames: map[string]string{"pc": "pc.img"}, + tempDirs: temporaryDirectories{ + rootfs: filepath.Join(testDataDir, "metadata", "root"), + unpack: filepath.Join(testDataDir, "metadata", "unpack"), + volumes: filepath.Join(testDataDir, "metadata", "volumes"), + }, + }, + shouldPass: true, + }, + { + name: "fail to write in inexistent directory", + stateMachine: &StateMachine{ + stateMachineFlags: &commands.StateMachineOpts{ + Resume: true, + WorkDir: filepath.Join("non-existent", "metadata"), + }, + CurrentStep: "", + StepsTaken: 2, + YamlFilePath: "/tmp/ubuntu-image-2329554237/unpack/gadget/meta/gadget.yaml", + }, + shouldPass: false, + expectedError: "error opening JSON metadata file for writing", + }, + } + for _, tc := range tests { + t.Run(tc.name, func(t *testing.T) { + asserter := helper.Asserter{T: t} + tName := strings.ReplaceAll(tc.name, " ", "_") + err := tc.stateMachine.writeMetadataJSON(fmt.Sprintf("%s.json", tName)) + + if tc.shouldPass { + want, err := os.ReadFile(filepath.Join(testDataDir, "metadata", fmt.Sprintf("reference_%s.json", tName))) + if err != nil { + t.Fatal("Unable to load reference metadata file: %w", err) + } + + got, err := os.ReadFile(filepath.Join(testDataDir, "metadata", fmt.Sprintf("%s.json", tName))) + if err != nil { + t.Fatal("Unable to load metadata file: %w", err) + } + + asserter.AssertEqual(want, got) + + } else { + asserter.AssertErrContains(err, tc.expectedError) + } + + }) + } +} diff --git a/internal/statemachine/testdata/metadata/reference_successful_write.json b/internal/statemachine/testdata/metadata/reference_successful_write.json new file mode 100644 index 00000000..4c7309df --- /dev/null +++ b/internal/statemachine/testdata/metadata/reference_successful_write.json @@ -0,0 +1 @@ +{"CurrentStep":"","StepsTaken":2,"YamlFilePath":"/tmp/ubuntu-image-2329554237/unpack/gadget/meta/gadget.yaml","IsSeeded":true,"SectorSize":512,"RootfsSize":775915520,"GadgetInfo":{"Volumes":{"pc":{"schema":"gpt","bootloader":"grub","id":"","structure":[{"name":"mbr","filesystem-label":"","offset":0,"offset-write":null,"min-size":440,"size":440,"type":"mbr","role":"mbr","id":"","filesystem":"","content":[{"source":"","target":"","image":"pc-boot.img","offset":null,"size":0,"unpack":false}],"update":{"edition":1,"preserve":null}}]}},"Defaults":null,"Connections":null,"KernelCmdline":{"Allow":null}},"ImageSizes":{"pc":3155165184},"VolumeOrder":["pc"],"VolumeNames":{"pc":"pc.img"}} \ No newline at end of file diff --git a/internal/statemachine/testdata/metadata/successful_write.json b/internal/statemachine/testdata/metadata/successful_write.json new file mode 100644 index 00000000..4c7309df --- /dev/null +++ b/internal/statemachine/testdata/metadata/successful_write.json @@ -0,0 +1 @@ +{"CurrentStep":"","StepsTaken":2,"YamlFilePath":"/tmp/ubuntu-image-2329554237/unpack/gadget/meta/gadget.yaml","IsSeeded":true,"SectorSize":512,"RootfsSize":775915520,"GadgetInfo":{"Volumes":{"pc":{"schema":"gpt","bootloader":"grub","id":"","structure":[{"name":"mbr","filesystem-label":"","offset":0,"offset-write":null,"min-size":440,"size":440,"type":"mbr","role":"mbr","id":"","filesystem":"","content":[{"source":"","target":"","image":"pc-boot.img","offset":null,"size":0,"unpack":false}],"update":{"edition":1,"preserve":null}}]}},"Defaults":null,"Connections":null,"KernelCmdline":{"Allow":null}},"ImageSizes":{"pc":3155165184},"VolumeOrder":["pc"],"VolumeNames":{"pc":"pc.img"}} \ No newline at end of file From 5ea93eb986381d79b809d209df7cc38c3bbb330f Mon Sep 17 00:00:00 2001 From: Paul Mars Date: Tue, 19 Sep 2023 10:32:19 +0200 Subject: [PATCH 05/13] Bump version in snapcraft.yaml --- snapcraft.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/snapcraft.yaml b/snapcraft.yaml index ffe23bde..a1521e43 100644 --- a/snapcraft.yaml +++ b/snapcraft.yaml @@ -3,7 +3,7 @@ summary: Create Ubuntu images description: | Official tool for building Ubuntu images, currently supporing Ubuntu Core snap-based images and preinstalled Ubuntu classic images. -version: 3.0+snap7 +version: 3.0+snap8 grade: stable confinement: classic base: core22 From 1be18cceb3b4c7db3b6d6f95dc8ddb20a052c20f Mon Sep 17 00:00:00 2001 From: Paul Mars Date: Tue, 19 Sep 2023 10:32:45 +0200 Subject: [PATCH 06/13] Remove old writeMetadata func --- internal/statemachine/state_machine.go | 23 ----------------------- 1 file changed, 23 deletions(-) diff --git a/internal/statemachine/state_machine.go b/internal/statemachine/state_machine.go index d1a6ccf5..6e8667c4 100644 --- a/internal/statemachine/state_machine.go +++ b/internal/statemachine/state_machine.go @@ -409,29 +409,6 @@ func (stateMachine *StateMachine) loadState(partialStateMachine *StateMachine) e return nil } -// writeMetadata writes the state machine info to disk. This will be used when resuming a -// partial state machine run -func (stateMachine *StateMachine) writeMetadata() error { - gobfilePath := filepath.Join(stateMachine.stateMachineFlags.WorkDir, "ubuntu-image.gob") - gobfile, err := os.OpenFile(gobfilePath, os.O_CREATE|os.O_WRONLY, 0644) - if err != nil && !os.IsExist(err) { - return fmt.Errorf("error opening metadata file for writing: %s", gobfilePath) - } - defer gobfile.Close() - enc := gob.NewEncoder(gobfile) - - // due to https://github.com/golang/go/issues/10415 we need to reset potentially tricky - // fields in the gadget before encoding - if stateMachine.GadgetInfo != nil { - gadget.ResetEnclosingVolumeInStructs(stateMachine.GadgetInfo.Volumes) - } - - if err := enc.Encode(stateMachine); err != nil { - return fmt.Errorf("failed to encode metatdata: %s", err.Error()) - } - return nil -} - // writeMetadataJSON writes the state machine info to disk, encoded as JSON. This will be used when resuming a // partial state machine run func (stateMachine *StateMachine) writeMetadataJSON(metadataFile string) error { From bbda0106741a86169b13e112c838ce6611953ad4 Mon Sep 17 00:00:00 2001 From: Paul Mars Date: Tue, 19 Sep 2023 10:39:54 +0200 Subject: [PATCH 07/13] Use JSON encoding in TestStateMachine setup and clean useless test --- internal/statemachine/state_machine_test.go | 17 +---------------- .../statemachine/testdata/ubuntu-image.gob | Bin 145 -> 0 bytes 2 files changed, 1 insertion(+), 16 deletions(-) delete mode 100644 internal/statemachine/testdata/ubuntu-image.gob diff --git a/internal/statemachine/state_machine_test.go b/internal/statemachine/state_machine_test.go index ab95083e..e9b19f43 100644 --- a/internal/statemachine/state_machine_test.go +++ b/internal/statemachine/state_machine_test.go @@ -277,7 +277,7 @@ func (TestStateMachine *testStateMachine) Setup() error { } // if --resume was passed, figure out where to start - if err := TestStateMachine.readMetadataGob(); err != nil { + if err := TestStateMachine.readMetadataJSON(metadataStateFile); err != nil { return err } @@ -438,21 +438,6 @@ func TestSetCommonOpts(t *testing.T) { }) } -// TestFailedMetadataParse tests a failure in parsing the metadata file. This is accomplished -// by giving the state machine a syntactically invalid metadata file to parse -func TestFailedMetadataParse(t *testing.T) { - t.Run("test_failed_metadata_parse", func(t *testing.T) { - asserter := helper.Asserter{T: t} - var stateMachine StateMachine - stateMachine.commonFlags, stateMachine.stateMachineFlags = helper.InitCommonOpts() - stateMachine.stateMachineFlags.Resume = true - stateMachine.stateMachineFlags.WorkDir = "testdata" - - err := stateMachine.readMetadataGob() - asserter.AssertErrContains(err, "failed to parse metadata file") - }) -} - // TestParseImageSizes tests a successful image size parse with all of the different allowed syntaxes func TestParseImageSizes(t *testing.T) { testCases := []struct { diff --git a/internal/statemachine/testdata/ubuntu-image.gob b/internal/statemachine/testdata/ubuntu-image.gob deleted file mode 100644 index a4bb440a6c6970bf6670b8eb885e3087b6962c3a..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 145 zcmXAhy$-@K5QB64EP*Fr^2SDIW@e`H0!MpQBT8E3uI%t)Nbq7LLb7bh`s}KL^+A!v z5g|T!2rbmu1b1%w5CvTrBvWi?IPMKs!Nf_WJz&m`ZcH#yQ-A!vKhGu6wk`+f|DJOB daq70E{{dR!F+u Date: Tue, 19 Sep 2023 11:29:58 +0200 Subject: [PATCH 08/13] Update debian/changelog --- debian/changelog | 3 +++ 1 file changed, 3 insertions(+) diff --git a/debian/changelog b/debian/changelog index 12bad566..70436e4c 100644 --- a/debian/changelog +++ b/debian/changelog @@ -25,6 +25,9 @@ ubuntu-image (3.0+23.04ubuntu1) UNRELEASED; urgency=medium * Call mount --make-rprivate and umount --recursive when undoing a bind mount from the host. (LP: #2033582) + [ Paul Mars ] + * Store state machine state as a JSON file to ease maintainability + -- Łukasz 'sil2100' Zemczak Fri, 14 Jul 2023 15:56:27 +0200 ubuntu-image (2.2+22.10ubuntu1) kinetic; urgency=medium From d40f2552032bd041155557e54aeb440697a7e1cc Mon Sep 17 00:00:00 2001 From: Paul Mars Date: Tue, 19 Sep 2023 11:51:25 +0200 Subject: [PATCH 09/13] Ignore test result files --- internal/statemachine/state_machine_test.go | 4 ++-- internal/statemachine/testdata/metadata/.gitignore | 1 + internal/statemachine/testdata/metadata/successful_write.json | 1 - 3 files changed, 3 insertions(+), 3 deletions(-) create mode 100644 internal/statemachine/testdata/metadata/.gitignore delete mode 100644 internal/statemachine/testdata/metadata/successful_write.json diff --git a/internal/statemachine/state_machine_test.go b/internal/statemachine/state_machine_test.go index e9b19f43..10d6909c 100644 --- a/internal/statemachine/state_machine_test.go +++ b/internal/statemachine/state_machine_test.go @@ -989,7 +989,7 @@ func TestStateMachine_writeMetadataJSON(t *testing.T) { t.Run(tc.name, func(t *testing.T) { asserter := helper.Asserter{T: t} tName := strings.ReplaceAll(tc.name, " ", "_") - err := tc.stateMachine.writeMetadataJSON(fmt.Sprintf("%s.json", tName)) + err := tc.stateMachine.writeMetadataJSON(fmt.Sprintf("result_%s.json", tName)) if tc.shouldPass { want, err := os.ReadFile(filepath.Join(testDataDir, "metadata", fmt.Sprintf("reference_%s.json", tName))) @@ -997,7 +997,7 @@ func TestStateMachine_writeMetadataJSON(t *testing.T) { t.Fatal("Unable to load reference metadata file: %w", err) } - got, err := os.ReadFile(filepath.Join(testDataDir, "metadata", fmt.Sprintf("%s.json", tName))) + got, err := os.ReadFile(filepath.Join(testDataDir, "metadata", fmt.Sprintf("result_%s.json", tName))) if err != nil { t.Fatal("Unable to load metadata file: %w", err) } diff --git a/internal/statemachine/testdata/metadata/.gitignore b/internal/statemachine/testdata/metadata/.gitignore new file mode 100644 index 00000000..6428aa9c --- /dev/null +++ b/internal/statemachine/testdata/metadata/.gitignore @@ -0,0 +1 @@ +result_*.json \ No newline at end of file diff --git a/internal/statemachine/testdata/metadata/successful_write.json b/internal/statemachine/testdata/metadata/successful_write.json deleted file mode 100644 index 4c7309df..00000000 --- a/internal/statemachine/testdata/metadata/successful_write.json +++ /dev/null @@ -1 +0,0 @@ -{"CurrentStep":"","StepsTaken":2,"YamlFilePath":"/tmp/ubuntu-image-2329554237/unpack/gadget/meta/gadget.yaml","IsSeeded":true,"SectorSize":512,"RootfsSize":775915520,"GadgetInfo":{"Volumes":{"pc":{"schema":"gpt","bootloader":"grub","id":"","structure":[{"name":"mbr","filesystem-label":"","offset":0,"offset-write":null,"min-size":440,"size":440,"type":"mbr","role":"mbr","id":"","filesystem":"","content":[{"source":"","target":"","image":"pc-boot.img","offset":null,"size":0,"unpack":false}],"update":{"edition":1,"preserve":null}}]}},"Defaults":null,"Connections":null,"KernelCmdline":{"Allow":null}},"ImageSizes":{"pc":3155165184},"VolumeOrder":["pc"],"VolumeNames":{"pc":"pc.img"}} \ No newline at end of file From 2798dc69debb718892da6dddfb9e602f39de99c5 Mon Sep 17 00:00:00 2001 From: Paul Mars Date: Tue, 19 Sep 2023 17:51:17 +0200 Subject: [PATCH 10/13] Fully remove gob encoding --- internal/statemachine/classic.go | 2 +- internal/statemachine/snap.go | 2 +- internal/statemachine/state_machine.go | 35 +++------------------ internal/statemachine/state_machine_test.go | 10 +++--- ubuntu-image.rst | 2 +- 5 files changed, 13 insertions(+), 38 deletions(-) diff --git a/internal/statemachine/classic.go b/internal/statemachine/classic.go index c9a82d39..38db9177 100644 --- a/internal/statemachine/classic.go +++ b/internal/statemachine/classic.go @@ -48,7 +48,7 @@ func (classicStateMachine *ClassicStateMachine) Setup() error { } // if --resume was passed, figure out where to start - if err := classicStateMachine.readMetadataJSON(metadataStateFile); err != nil { + if err := classicStateMachine.readMetadata(metadataStateFile); err != nil { return err } diff --git a/internal/statemachine/snap.go b/internal/statemachine/snap.go index cb7d0b81..2d60e198 100644 --- a/internal/statemachine/snap.go +++ b/internal/statemachine/snap.go @@ -48,7 +48,7 @@ func (snapStateMachine *SnapStateMachine) Setup() error { } // if --resume was passed, figure out where to start - if err := snapStateMachine.readMetadataJSON(metadataStateFile); err != nil { + if err := snapStateMachine.readMetadata(metadataStateFile); err != nil { return err } diff --git a/internal/statemachine/state_machine.go b/internal/statemachine/state_machine.go index 6e8667c4..c514c986 100644 --- a/internal/statemachine/state_machine.go +++ b/internal/statemachine/state_machine.go @@ -4,7 +4,6 @@ package statemachine import ( "crypto/rand" - "encoding/gob" "encoding/json" "fmt" "io" @@ -333,32 +332,8 @@ func (stateMachine *StateMachine) postProcessGadgetYaml() error { return nil } -// readMetadataGob reads info about a partial state machine encoded as gob from disk -func (stateMachine *StateMachine) readMetadataGob() error { - // handle the resume case - if !stateMachine.stateMachineFlags.Resume { - return nil - } - // open the ubuntu-image.gob file and load the state - var partialStateMachine = new(StateMachine) - gobfilePath := filepath.Join(stateMachine.stateMachineFlags.WorkDir, "ubuntu-image.gob") - gobfile, err := os.Open(gobfilePath) - if err != nil { - return fmt.Errorf("error reading metadata file: %s", err.Error()) - } - defer gobfile.Close() - - dec := gob.NewDecoder(gobfile) - err = dec.Decode(&partialStateMachine) - if err != nil { - return fmt.Errorf("failed to parse metadata file: %s", err.Error()) - } - - return stateMachine.loadState(partialStateMachine) -} - -// readMetadataJSON reads info about a partial state machine encoded as JSON from disk -func (stateMachine *StateMachine) readMetadataJSON(metadataFile string) error { +// readMetadata reads info about a partial state machine encoded as JSON from disk +func (stateMachine *StateMachine) readMetadata(metadataFile string) error { if !stateMachine.stateMachineFlags.Resume { return nil } @@ -409,9 +384,9 @@ func (stateMachine *StateMachine) loadState(partialStateMachine *StateMachine) e return nil } -// writeMetadataJSON writes the state machine info to disk, encoded as JSON. This will be used when resuming a +// writeMetadata writes the state machine info to disk, encoded as JSON. This will be used when resuming a // partial state machine run -func (stateMachine *StateMachine) writeMetadataJSON(metadataFile string) error { +func (stateMachine *StateMachine) writeMetadata(metadataFile string) error { jsonfilePath := filepath.Join(stateMachine.stateMachineFlags.WorkDir, metadataFile) jsonfile, err := os.OpenFile(jsonfilePath, os.O_CREATE|os.O_WRONLY, 0644) if err != nil && !os.IsExist(err) { @@ -481,5 +456,5 @@ func (stateMachine *StateMachine) Teardown() error { if stateMachine.cleanWorkDir { return stateMachine.cleanup() } - return stateMachine.writeMetadataJSON(metadataStateFile) + return stateMachine.writeMetadata(metadataStateFile) } diff --git a/internal/statemachine/state_machine_test.go b/internal/statemachine/state_machine_test.go index 10d6909c..ff6b3a17 100644 --- a/internal/statemachine/state_machine_test.go +++ b/internal/statemachine/state_machine_test.go @@ -277,7 +277,7 @@ func (TestStateMachine *testStateMachine) Setup() error { } // if --resume was passed, figure out where to start - if err := TestStateMachine.readMetadataJSON(metadataStateFile); err != nil { + if err := TestStateMachine.readMetadata(metadataStateFile); err != nil { return err } @@ -786,7 +786,7 @@ func TestFailedPostProcessGadgetYaml(t *testing.T) { }) } -func TestStateMachine_readMetadataJSON(t *testing.T) { +func TestStateMachine_readMetadata(t *testing.T) { type args struct { metadataFile string } @@ -902,7 +902,7 @@ func TestStateMachine_readMetadataJSON(t *testing.T) { states: allTestStates, } - err := gotStateMachine.readMetadataJSON(tc.args.metadataFile) + err := gotStateMachine.readMetadata(tc.args.metadataFile) if tc.shouldPass { asserter.AssertEqual(tc.wantStateMachine, gotStateMachine, cmpOpts...) } else { @@ -912,7 +912,7 @@ func TestStateMachine_readMetadataJSON(t *testing.T) { } } -func TestStateMachine_writeMetadataJSON(t *testing.T) { +func TestStateMachine_writeMetadata(t *testing.T) { tests := []struct { name string stateMachine *StateMachine @@ -989,7 +989,7 @@ func TestStateMachine_writeMetadataJSON(t *testing.T) { t.Run(tc.name, func(t *testing.T) { asserter := helper.Asserter{T: t} tName := strings.ReplaceAll(tc.name, " ", "_") - err := tc.stateMachine.writeMetadataJSON(fmt.Sprintf("result_%s.json", tName)) + err := tc.stateMachine.writeMetadata(fmt.Sprintf("result_%s.json", tName)) if tc.shouldPass { want, err := os.ReadFile(filepath.Join(testDataDir, "metadata", fmt.Sprintf("reference_%s.json", tName))) diff --git a/ubuntu-image.rst b/ubuntu-image.rst index 604ed209..9dcc4c51 100644 --- a/ubuntu-image.rst +++ b/ubuntu-image.rst @@ -199,7 +199,7 @@ These are some options for controlling this state machine. Other than ``--workdir``, these options are mutually exclusive. When ``--until`` or ``--thru`` is given, the state machine can be resumed later with ``--resume``, but ``--workdir`` must be given in that case since the state is saved in a -``ubuntu-image.gob`` file in the working directory. +``ubuntu-image.json`` file in the working directory. -w DIRECTORY, --workdir DIRECTORY The working directory in which to download and unpack all the source files From aa6452b84361a1b7dae17e538e1507ca43d68ee5 Mon Sep 17 00:00:00 2001 From: Paul Mars Date: Tue, 19 Sep 2023 17:51:42 +0200 Subject: [PATCH 11/13] Test readMetadata when not resuming --- internal/statemachine/state_machine_test.go | 23 ++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/internal/statemachine/state_machine_test.go b/internal/statemachine/state_machine_test.go index ff6b3a17..6fd69ebc 100644 --- a/internal/statemachine/state_machine_test.go +++ b/internal/statemachine/state_machine_test.go @@ -789,6 +789,7 @@ func TestFailedPostProcessGadgetYaml(t *testing.T) { func TestStateMachine_readMetadata(t *testing.T) { type args struct { metadataFile string + resume bool } cmpOpts := []cmp.Option{ @@ -813,6 +814,7 @@ func TestStateMachine_readMetadata(t *testing.T) { name: "successful read", args: args{ metadataFile: "successful_read.json", + resume: true, }, wantStateMachine: &StateMachine{ stateMachineFlags: &commands.StateMachineOpts{ @@ -867,6 +869,7 @@ func TestStateMachine_readMetadata(t *testing.T) { name: "invalid format", args: args{ metadataFile: "invalid_format.json", + resume: true, }, wantStateMachine: nil, shouldPass: false, @@ -876,15 +879,33 @@ func TestStateMachine_readMetadata(t *testing.T) { name: "missing state file", args: args{ metadataFile: "inexistent.json", + resume: true, }, wantStateMachine: nil, shouldPass: false, expectedError: "error reading metadata file", }, + { + name: "do nothing if not resuming", + args: args{ + metadataFile: "unimportant.json", + resume: false, + }, + wantStateMachine: &StateMachine{ + stateMachineFlags: &commands.StateMachineOpts{ + Resume: false, + WorkDir: filepath.Join(testDataDir, "metadata"), + }, + states: allTestStates, + }, + shouldPass: true, + expectedError: "error reading metadata file", + }, { name: "state file with too many steps", args: args{ metadataFile: "too_many_steps.json", + resume: true, }, wantStateMachine: nil, shouldPass: false, @@ -896,7 +917,7 @@ func TestStateMachine_readMetadata(t *testing.T) { asserter := helper.Asserter{T: t} gotStateMachine := &StateMachine{ stateMachineFlags: &commands.StateMachineOpts{ - Resume: true, + Resume: tc.args.resume, WorkDir: filepath.Join(testDataDir, "metadata"), }, states: allTestStates, From 7d7e88577cacc8623533ac6c610256e9e0842088 Mon Sep 17 00:00:00 2001 From: Paul Mars Date: Tue, 19 Sep 2023 17:55:24 +0200 Subject: [PATCH 12/13] Mark asserter methods as test helpers This object should be moved to a dedicated pacakge to avoid mixing actual code helpers and test helpers. This would make a clear distinctions between those two kind and avoid using test helpers in actual code by mistake. It would also avoid reporting coverage on this code. --- internal/helper/asserter.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/internal/helper/asserter.go b/internal/helper/asserter.go index 3ae7118e..379987cc 100644 --- a/internal/helper/asserter.go +++ b/internal/helper/asserter.go @@ -17,6 +17,7 @@ type Asserter struct { // ends the test on a non-nil error. Otherwise, it lets the test continue running // but marks it as failed func (asserter *Asserter) AssertErrNil(err error, fatal bool) { + asserter.Helper() if err != nil { debug.PrintStack() if fatal { @@ -29,6 +30,7 @@ func (asserter *Asserter) AssertErrNil(err error, fatal bool) { // AssertErrContains asserts that an error is non-nil, and that the error // message string contains a sub-string that is passed in func (asserter *Asserter) AssertErrContains(err error, errString string) { + asserter.Helper() if err == nil { debug.PrintStack() asserter.Error("Expected an error, but got none") @@ -42,6 +44,7 @@ func (asserter *Asserter) AssertErrContains(err error, errString string) { // AssertEqual asserts that two objects are equal using go-cmp func (asserter *Asserter) AssertEqual(want, got interface{}, cmpOpts ...cmp.Option) { + asserter.Helper() diff := cmp.Diff(want, got, cmpOpts...) if want != nil && diff != "" { asserter.Errorf("mismatch (-want +got):\n%s", diff) From 3779438f67dc0bd8a2ee9dc49b3e1542ab5b8dfa Mon Sep 17 00:00:00 2001 From: Paul Mars Date: Thu, 21 Sep 2023 14:20:36 +0200 Subject: [PATCH 13/13] Test failing to marshal the stateMachine --- internal/statemachine/state_machine_test.go | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/internal/statemachine/state_machine_test.go b/internal/statemachine/state_machine_test.go index 6fd69ebc..42809d30 100644 --- a/internal/statemachine/state_machine_test.go +++ b/internal/statemachine/state_machine_test.go @@ -991,6 +991,27 @@ func TestStateMachine_writeMetadata(t *testing.T) { }, shouldPass: true, }, + { + name: "fail to marshall an invalid stateMachine - use a GadgetInfo with a channel", + stateMachine: &StateMachine{ + stateMachineFlags: &commands.StateMachineOpts{ + Resume: true, + WorkDir: filepath.Join(testDataDir, "metadata"), + }, + GadgetInfo: &gadget.Info{ + Defaults: map[string]map[string]interface{}{ + "key": { + "key": make(chan int), + }, + }, + }, + CurrentStep: "", + StepsTaken: 2, + YamlFilePath: "/tmp/ubuntu-image-2329554237/unpack/gadget/meta/gadget.yaml", + }, + shouldPass: false, + expectedError: "failed to JSON encode metadata", + }, { name: "fail to write in inexistent directory", stateMachine: &StateMachine{