feat: fall back to manifest.json when get-manifest hook is unavailable #629
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,6 +24,7 @@ import ( | |
| "github.com/slackapi/slack-cli/internal/slackcontext" | ||
| "github.com/slackapi/slack-cli/internal/slackdeps" | ||
| "github.com/slackapi/slack-cli/internal/slackerror" | ||
| "github.com/spf13/afero" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/mock" | ||
| "github.com/stretchr/testify/require" | ||
|
|
@@ -68,77 +69,113 @@ func Test_AppManifest_SetManifestEnvTeamVars(t *testing.T) { | |
| } | ||
|
|
||
| func Test_AppManifest_GetManifestLocal(t *testing.T) { | ||
| t.Run("reads manifest.json directly when it exists", func(t *testing.T) { | ||
| ctx := slackcontext.MockContext(t.Context()) | ||
| fsMock := slackdeps.NewFsMock() | ||
| osMock := slackdeps.NewOsMock() | ||
| osMock.AddDefaultMocks() | ||
| configMock := config.NewConfig(fsMock, osMock) | ||
| mockSDKConfig := hooks.NewSDKConfigMock() | ||
| mockSDKConfig.WorkingDirectory = "/project" | ||
| mockSDKConfig.Hooks.GetManifest = hooks.HookScript{Name: "GetManifest", Command: "echo manifest"} | ||
|
|
||
| _ = fsMock.MkdirAll("/project", 0755) | ||
| _ = afero.WriteFile(fsMock, "/project/manifest.json", []byte(`{"display_information":{"name":"file-app"}}`), 0644) | ||
|
|
||
| mockHookExecutor := &hooks.MockHookExecutor{} | ||
| manifestClient := NewManifestClient(&api.APIMock{}, configMock, fsMock) | ||
|
|
||
| result, err := manifestClient.GetManifestLocal(ctx, mockSDKConfig, mockHookExecutor) | ||
| require.NoError(t, err) | ||
| assert.Equal(t, "file-app", result.DisplayInformation.Name) | ||
| mockHookExecutor.AssertNotCalled(t, "Execute", mock.Anything, mock.Anything) | ||
| }) | ||
|
|
||
| t.Run("errors if no manifest.json and no get-manifest hook exists", func(t *testing.T) { | ||
| ctx := slackcontext.MockContext(t.Context()) | ||
| fsMock := slackdeps.NewFsMock() | ||
| osMock := slackdeps.NewOsMock() | ||
| osMock.AddDefaultMocks() | ||
| configMock := config.NewConfig(fsMock, osMock) | ||
| mockSDKConfig := hooks.NewSDKConfigMock() | ||
| mockSDKConfig.Hooks.GetManifest = hooks.HookScript{Name: "GetManifest"} | ||
|
|
||
| mockHookExecutor := &hooks.MockHookExecutor{} | ||
| manifestClient := NewManifestClient(&api.APIMock{}, configMock, fsMock) | ||
|
|
||
| _, err := manifestClient.GetManifestLocal(ctx, mockSDKConfig, mockHookExecutor) | ||
| require.Error(t, err) | ||
| assert.Equal(t, slackerror.ErrSDKHookNotFound, err.(*slackerror.Error).Code) | ||
| }) | ||
|
|
||
| t.Run("errors if manifest.json contains invalid JSON", func(t *testing.T) { | ||
| ctx := slackcontext.MockContext(t.Context()) | ||
| fsMock := slackdeps.NewFsMock() | ||
| osMock := slackdeps.NewOsMock() | ||
| osMock.AddDefaultMocks() | ||
| configMock := config.NewConfig(fsMock, osMock) | ||
| mockSDKConfig := hooks.NewSDKConfigMock() | ||
| mockSDKConfig.WorkingDirectory = "/project" | ||
|
|
||
| _ = fsMock.MkdirAll("/project", 0755) | ||
| _ = afero.WriteFile(fsMock, "/project/manifest.json", []byte(`not json`), 0644) | ||
|
|
||
| mockHookExecutor := &hooks.MockHookExecutor{} | ||
| manifestClient := NewManifestClient(&api.APIMock{}, configMock, fsMock) | ||
|
|
||
| _, err := manifestClient.GetManifestLocal(ctx, mockSDKConfig, mockHookExecutor) | ||
| require.Error(t, err) | ||
| assert.Equal(t, slackerror.ErrInvalidManifest, err.(*slackerror.Error).Code) | ||
| }) | ||
|
|
||
| hookFallbackTests := map[string]struct { | ||
| hookOutput string | ||
| hookErr error | ||
| expectedName string | ||
| expectedErr string | ||
| }{ | ||
| "falls back to hook when no manifest.json exists": { | ||
| hookOutput: `{"display_information":{"name":"hook-app"}}`, | ||
| expectedName: "hook-app", | ||
| }, | ||
| "parses hook output with leading characters": { | ||
| hookOutput: `...{"display_information":{"name":"hook-app"}}`, | ||
| expectedName: "hook-app", | ||
| }, | ||
| "errors if hook execution errors": { | ||
| hookOutput: `{}`, | ||
| hookErr: slackerror.New(slackerror.ErrNoFile), | ||
| expectedErr: slackerror.ErrInvalidManifest, | ||
| }, | ||
| "errors if hook output has no JSON": { | ||
| hookOutput: `...unknown`, | ||
| expectedErr: slackerror.ErrInvalidManifest, | ||
| }, | ||
| } | ||
| for name, tc := range hookFallbackTests { | ||
| t.Run(name, func(t *testing.T) { | ||
| ctx := slackcontext.MockContext(t.Context()) | ||
| fsMock := slackdeps.NewFsMock() | ||
| osMock := slackdeps.NewOsMock() | ||
| osMock.AddDefaultMocks() | ||
| configMock := config.NewConfig(fsMock, osMock) | ||
| configMock.DomainAuthTokens = "api.slack.com" | ||
| mockSDKConfig := hooks.NewSDKConfigMock() | ||
| mockSDKConfig.Hooks.GetManifest = hooks.HookScript{Name: "GetManifest", Command: "generate-manifest"} | ||
|
|
||
| mockHookExecutor := &hooks.MockHookExecutor{} | ||
| mockHookExecutor.On("Execute", mock.Anything, mock.Anything). | ||
| Return(tc.hookOutput, tc.hookErr) | ||
|
|
||
| manifestClient := NewManifestClient(&api.APIMock{}, configMock, fsMock) | ||
|
|
||
| result, err := manifestClient.GetManifestLocal(ctx, mockSDKConfig, mockHookExecutor) | ||
| if tc.expectedErr != "" { | ||
| require.Error(t, err) | ||
| assert.Equal(t, tc.expectedErr, err.(*slackerror.Error).Code) | ||
| } else { | ||
| require.NoError(t, err) | ||
| assert.Equal(t, tc.expectedName, result.DisplayInformation.Name) | ||
| } | ||
| }) | ||
| } | ||
|
|
@@ -186,7 +223,7 @@ func Test_AppManifest_GetManifestRemote(t *testing.T) { | |
| apic := &api.APIMock{} | ||
| apic.On("ExportAppManifest", mock.Anything, mock.Anything, mock.Anything). | ||
| Return(api.ExportAppResult{Manifest: tc.mockManifestResponse}, tc.mockManifestError) | ||
| manifestClient := NewManifestClient(apic, configMock, fsMock) | ||
|
|
||
| manifest, err := manifestClient.GetManifestRemote(ctx, tc.mockToken, tc.mockAppID) | ||
| if tc.expectedError != nil { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -173,52 +173,45 @@ func Test_Sync(t *testing.T) { | |
| assert.Equal(t, slackerror.ErrAppManifestUpdate, slackErr.Code) | ||
| }) | ||
|
|
||
| mergeStrategyTests := map[string]struct { | ||
| forceFlag bool | ||
| forceRemoteFlag bool | ||
| expectedDesc string | ||
| }{ | ||
| "force flag merges all local": { | ||
| forceFlag: true, | ||
| expectedDesc: "Local", | ||
| }, | ||
| "force-remote flag merges all remote": { | ||
| forceRemoteFlag: true, | ||
| expectedDesc: "Remote", | ||
| }, | ||
| } | ||
| for name, tc := range mergeStrategyTests { | ||
| t.Run(name, func(t *testing.T) { | ||
| f := newSyncTestFixture(t) | ||
| f.projectConfig.On("GetManifestSource", mock.Anything).Return(config.ManifestSourceLocal, nil) | ||
| f.manifestMock.On("GetManifestLocal", mock.Anything, mock.Anything, mock.Anything). | ||
| Return(localManifest, nil) | ||
| f.manifestMock.On("GetManifestRemote", mock.Anything, mock.Anything, mock.Anything). | ||
| Return(remoteManifest, nil) | ||
| f.clients.Config.ForceFlag = tc.forceFlag | ||
| f.clients.Config.ForceRemoteFlag = tc.forceRemoteFlag | ||
| f.clientsMock.API.On("UpdateApp", mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything). | ||
| Return(api.UpdateAppResult{}, nil) | ||
| f.cacheMock.On("NewManifestHash", mock.Anything, mock.Anything).Return(cache.Hash("newhash"), nil) | ||
| f.cacheMock.On("SetManifestHash", mock.Anything, mock.Anything, mock.Anything).Return(nil) | ||
| _ = afero.WriteFile(f.fs, "/project/manifest.json", []byte(`{"display_information":{"name":"App"}}`), 0644) | ||
|
|
||
| result, err := Sync(f.ctx, f.clients, testApp, testAuth) | ||
|
|
||
| require.NoError(t, err) | ||
| require.NotNil(t, result) | ||
| assert.True(t, result.HasDifferences) | ||
| assert.True(t, result.WriteBack.Written) | ||
| assert.Equal(t, tc.expectedDesc, result.Merged.DisplayInformation.Description) | ||
| }) | ||
| } | ||
|
|
||
| t.Run("API UpdateApp failure is propagated", func(t *testing.T) { | ||
| f := newSyncTestFixture(t) | ||
|
|
@@ -279,7 +272,7 @@ func Test_Sync(t *testing.T) { | |
| assert.Contains(t, err.Error(), "cache") | ||
| }) | ||
|
|
||
| t.Run("missing manifest.json creates the file", func(t *testing.T) { | ||
| f := newSyncTestFixture(t) | ||
| f.projectConfig.On("GetManifestSource", mock.Anything).Return(config.ManifestSourceLocal, nil) | ||
| f.manifestMock.On("GetManifestLocal", mock.Anything, mock.Anything, mock.Anything). | ||
|
|
@@ -297,7 +290,7 @@ func Test_Sync(t *testing.T) { | |
| require.NoError(t, err) | ||
| require.NotNil(t, result) | ||
| assert.True(t, result.HasDifferences) | ||
| assert.True(t, result.WriteBack.Written) | ||
| }) | ||
|
|
||
| t.Run("TTY interactive resolution with all-local strategy", func(t *testing.T) { | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔭 thought: We should reverse this order to check if a
get-manifesthook exists and fallback to reading "manifest.json" file. Deprecating the hook might happen at the hook package while the CLI continues to support it.