package kiosk_test import ( "context" "encoding/json" "errors" "fmt" "log" "net/http" "net/http/httptest" "os" "path/filepath" "testing" "git.golem15.com/golem15/summercms/modules/backpack" "git.golem15.com/golem15/summercms/modules/compass" "git.golem15.com/golem15/summercms/modules/kiosk" ) // Marshal writes the plugin.yaml bytes: the generated header, the fields // in a fixed order and the required plugins sorted by ID. func ExampleMarshal() { out, err := kiosk.Marshal(kiosk.Manifest{ Schema: kiosk.SchemaVersion, ID: "acme.shop", Module: "example.test/sm-shop-plugin", Package: "example.test/sm-shop-plugin", Name: "Shop", Description: "Products, carts and orders.", Framework: "v0.6.0", Requires: kiosk.Requires{"acme.user": "v0.1.2", "acme.payment": ""}, }) if err != nil { fmt.Println(err) return } fmt.Print(string(out)) // Output: // # Generated by summer plugin:manifest. Do not edit; rerun the command. // schema: 1 // id: acme.shop // module: example.test/sm-shop-plugin // package: example.test/sm-shop-plugin // name: Shop // description: Products, carts and orders. // framework: v0.6.0 // requires: // acme.payment: "" // acme.user: v0.1.2 } // NewestCompatible picks the newest release whose framework minimum the // application's framework meets; the list order does not matter. func ExampleNewestCompatible() { versions := []kiosk.RegistryVersion{ {Version: "v0.3.0", Framework: "v0.7.0"}, {Version: "v0.2.1", Framework: "v0.6.0"}, {Version: "v0.1.0", Framework: "v0.5.0"}, } for _, framework := range []string{"v0.6.2", "v0.7.0", "v0.4.0"} { v, ok := kiosk.NewestCompatible(versions, framework) fmt.Println(framework, v.Version, ok) } // Output: // v0.6.2 v0.2.1 true // v0.7.0 v0.3.0 true // v0.4.0 false } // writeManifest regenerates the plugin.yaml of the plugin in dir and checks // that the committed file is current. func writeManifest(ctx context.Context, dir string) error { // docs:start write path, warnings, err := kiosk.Write(ctx, dir, kiosk.DeriveOptions{}) if err != nil { return err } for _, w := range warnings { log.Println(w) } fmt.Println("wrote", path) if err := kiosk.Check(ctx, dir); err != nil { var stale *kiosk.StaleError if errors.As(err, &stale) { fmt.Printf("expected:\n%s", stale.Want) } return err } // docs:end write return nil } // TestDocsWriteManifest runs writeManifest on a copy of the literal fixture // plugin without its plugin.yaml and compares the result with the // committed one. func TestDocsWriteManifest(t *testing.T) { dir := t.TempDir() if err := os.CopyFS(dir, os.DirFS("testdata/literal")); err != nil { t.Fatal(err) } if err := os.Remove(filepath.Join(dir, kiosk.FileName)); err != nil { t.Fatal(err) } if err := writeManifest(t.Context(), dir); err != nil { t.Fatal(err) } got, err := os.ReadFile(filepath.Join(dir, kiosk.FileName)) if err != nil { t.Fatal(err) } want, err := os.ReadFile(filepath.Join("testdata", "literal", kiosk.FileName)) if err != nil { t.Fatal(err) } if string(got) != string(want) { t.Fatalf("plugin.yaml =\n%s\nwant\n%s", got, want) } } // pickRelease prints the go get line of the newest release in a registry // versions answer that an application on framework v0.6.2 can install. func pickRelease(body []byte) error { // docs:start newest var versions kiosk.VersionsResponse if err := json.Unmarshal(body, &versions); err != nil { return err } v, ok := kiosk.NewestCompatible(versions.Data, "v0.6.2") if !ok { return errors.New("every release needs a newer framework") } fmt.Println("go get", v.Module+"@"+v.Version) // docs:end newest return nil } func ExampleVersionsResponse() { // The body of GET {registry}/api/v1/plugins/acme.blog/versions. body := []byte(`{"data":[ {"version":"v0.3.0","framework":"v0.7.0","module":"example.test/sm-blog-plugin"}, {"version":"v0.2.1","framework":"v0.6.0","module":"example.test/sm-blog-plugin"} ]}`) if err := pickRelease(body); err != nil { fmt.Println(err) } if err := pickRelease([]byte(`{"data":[{"version":"v0.3.0","framework":"v0.7.0"}]}`)); err != nil { fmt.Println(err) } // Output: // go get example.test/sm-blog-plugin@v0.2.1 // every release needs a newer framework } // blogReleases asks the configured registry for the releases of acme.blog. func blogReleases(ctx context.Context, app *backpack.App) ([]kiosk.RegistryVersion, error) { // docs:start client client, err := kiosk.NewClient(kiosk.RegistryURL(app.Config), app.Config) if errors.Is(err, kiosk.ErrRegistryDisabled) { return nil, nil // plugins.registry_url is empty: no registry calls } if err != nil { return nil, err } versions, err := client.Versions(ctx, "acme.blog") if errors.Is(err, kiosk.ErrNotFound) { return nil, fmt.Errorf("acme.blog is not listed") } // docs:end client return versions, err } // TestDocsBlogReleases runs blogReleases against a stand-in registry, with // the registry disabled, and against a registry that does not list the // plugin. func TestDocsBlogReleases(t *testing.T) { listed := true registry := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { if !listed || r.URL.Path != kiosk.RegistryAPIPath+"/plugins/acme.blog/versions" { w.WriteHeader(http.StatusNotFound) return } _ = json.NewEncoder(w).Encode(kiosk.VersionsResponse{Data: []kiosk.RegistryVersion{{Version: "v0.2.1", Framework: "v0.6.0"}}}) })) defer registry.Close() appWith := func(url string) *backpack.App { cfg, err := compass.Open(compass.Options{Dir: t.TempDir(), Environ: []string{}}) if err != nil { t.Fatal(err) } if err := cfg.Set("plugins.registry_url", url); err != nil { t.Fatal(err) } return backpack.New(cfg) } versions, err := blogReleases(t.Context(), appWith(registry.URL)) if err != nil || len(versions) != 1 || versions[0].Version != "v0.2.1" { t.Fatalf("releases = %+v, %v", versions, err) } if versions, err := blogReleases(t.Context(), appWith("")); err != nil || versions != nil { t.Fatalf("disabled registry = %+v, %v", versions, err) } listed = false if _, err := blogReleases(t.Context(), appWith(registry.URL)); err == nil || err.Error() != "acme.blog is not listed" { t.Fatalf("unlisted plugin = %v", err) } }