import-dir uploads secondary artifacts before their primary API definition

Fechada Para iniciantes
  • Algo errado?
#561 4 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 3 dias

@doraem-on já está trabalhando nisso.

Desde 1/10/2026.

  • #562 de @doraem-on — aberto

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
88/100
Tipo de issue
Bug
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
go
Domínio
cli

Direção de pesquisa

Comece em cmd/importDir.go, na parte relacionada à lógica de descoberta e upload de ImportDirectory, e depois adicione ou execute cmd/import_order_regression_test.go. Confirme que openapi.yaml é carregado antes de examples.yaml, preservando a ordem relativa dentro de cada grupo de status primário, e garanta que os testes de cmd passem.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

component/cli kind/bug
Problem

import-dir can upload a secondary artifact before its primary API definition. For example, a directory containing examples.yaml and openapi.yaml uploads examples.yaml with primary=false first, then openapi.yaml with primary=true.

ImportDirectory uploads files in their discovery order. RealFileSystem uses filepath.Walk, so lexical filename order determines which artifact is uploaded first; the files are not grouped by primary/secondary status.

The multi-artifact documentation explains that a secondary artifact is ignored when its matching API name/version does not yet exist. On a first import, this ordering can therefore leave the API without the examples from its secondary artifact.

Expected behavior

Upload primary artifacts before secondary artifacts, regardless of filename order, so the API definition exists before its secondary artifacts are imported.

Reproduction test

Tested on upstream master at e54dc4719d1f14085f5bb551a910139628babbbc, with go version go1.26.5 darwin/arm64 (macOS, ARM64).

Save this as cmd/import_order_regression_test.go and run:

go test ./cmd -run '^TestReviewImportDirPrimaryOrder$' -count=1 -v

The test calls the production ImportDirectory with RealFileSystem and records calls to the upload client. Fixture contents are placeholders because the recording client does not parse them.

package cmd

import (
	"fmt"
	"os"
	"path/filepath"
	"testing"
)

type reviewUploadClient struct{ calls []string }

func (c *reviewUploadClient) UploadArtifact(path string, primary bool) (string, error) {
	c.calls = append(c.calls, fmt.Sprintf("%s primary=%t", filepath.Base(path), primary))
	return "accepted", nil
}

func TestReviewImportDirPrimaryOrder(t *testing.T) {
	dir := t.TempDir()
	for _, name := range []string{"examples.yaml", "openapi.yaml"} {
		if err := os.WriteFile(filepath.Join(dir, name), []byte("fixture"), 0600); err != nil {
			t.Fatal(err)
		}
	}
	client := &reviewUploadClient{}
	result, err := ImportDirectory(client, &RealFileSystem{}, dir, ImportConfig{})
	if err != nil {
		t.Fatal(err)
	}
	t.Logf("upload order: %v; success=%d failed=%d", client.calls, result.SuccessCount, result.FailedCount)
	if client.calls[0] != "openapi.yaml primary=true" {
		t.Errorf("secondary artifact uploaded before the primary API definition")
	}
}
Actual test output

For the recorded run, the test file was supplied through a temporary Go overlay to leave the checkout unchanged:

go test -overlay=/tmp/microcks-import-order-overlay.json ./cmd -run '^TestReviewImportDirPrimaryOrder$' -count=1 -v

=== RUN   TestReviewImportDirPrimaryOrder
Microcks has completed 'accepted'
Microcks has discovered 'accepted'
    import_order_regression_test.go:29: upload order: [examples.yaml primary=false openapi.yaml primary=true]; success=2 failed=0
    import_order_regression_test.go:31: secondary artifact uploaded before the primary API definition
--- FAIL: TestReviewImportDirPrimaryOrder (0.00s)
FAIL
FAIL	github.com/microcks/microcks-cli/cmd	0.917s
FAIL

Exit status: 1. The secondary artifact was uploaded first.

This test confirms the CLI upload order only. The accepted responses and success counters come from the recording client, not a live Microcks server. The missing-examples impact follows from the documented secondary-artifact behavior; I have not run a live-server reproduction.

A possible fix is to stably group the discovered files by IsPrimary before uploading them, keeping the existing relative order within each group.

I searched existing issues and PRs for import-dir ordering/primary/secondary reports and found no matching report. PR #459 concerns import-url success-message wording, not directory upload ordering.

Linguagem predominante
Go
Estrelas
59
Forks
75
Merge médio
7d 12h
PRs com merge (30d)
20

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de microcks/microcks-cli

Todas as issues de microcks/microcks-cli

Issues semelhantes

Mais issues de Go

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.