From 23afd93b3859347127ff50210c9fd941101f54cc Mon Sep 17 00:00:00 2001 From: Ale Mercado Date: Mon, 27 Apr 2026 15:45:32 -0400 Subject: [PATCH 1/3] fix: add assets/icon.png fallback for icon auto-detection The icon upload fallback only checked for icon.png in the project root. This adds assets/icon.png as the first fallback path, matching the convention used by slack-samples template repos and the existing auto-detection in slack_yaml.go. --- internal/pkg/apps/install.go | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/internal/pkg/apps/install.go b/internal/pkg/apps/install.go index 9dcd68ee..feaea2cc 100644 --- a/internal/pkg/apps/install.go +++ b/internal/pkg/apps/install.go @@ -218,10 +218,12 @@ func Install(ctx context.Context, clients *shared.ClientFactory, auth types.Slac } } - // upload icon, default to icon.png + // upload icon, default to assets/icon.png or icon.png var iconPath = slackManifest.Icon if iconPath == "" { - if _, err := os.Stat("icon.png"); !os.IsNotExist(err) { + if _, err := os.Stat("assets/icon.png"); !os.IsNotExist(err) { + iconPath = "assets/icon.png" + } else if _, err := os.Stat("icon.png"); !os.IsNotExist(err) { iconPath = "icon.png" } } @@ -526,7 +528,9 @@ func InstallLocalApp(ctx context.Context, clients *shared.ClientFactory, orgGran if clients.Config.WithExperimentOn(experiment.SetIcon) { var iconPath = slackManifest.Icon if iconPath == "" { - if _, err := os.Stat("icon.png"); !os.IsNotExist(err) { + if _, err := os.Stat("assets/icon.png"); !os.IsNotExist(err) { + iconPath = "assets/icon.png" + } else if _, err := os.Stat("icon.png"); !os.IsNotExist(err) { iconPath = "icon.png" } } From 5176129057b9f4378be9a49eb7f68417d8f11c68 Mon Sep 17 00:00:00 2001 From: Ale Mercado Date: Tue, 28 Apr 2026 16:31:53 -0400 Subject: [PATCH 2/3] feat: support png, jpg, jpeg, gif for icon auto-detection Extract resolveIconPath to centralize icon fallback logic across Install and InstallLocalApp. Search for icon.{png,jpg,jpeg,gif} in assets/ then project root, matching all formats the API accepts. --- internal/pkg/apps/install.go | 40 ++++++++------- internal/pkg/apps/install_test.go | 64 ++++++++++++++++++++++++ internal/shared/types/slack_yaml.go | 14 ++++-- internal/shared/types/slack_yaml_test.go | 25 +++++++++ 4 files changed, 120 insertions(+), 23 deletions(-) diff --git a/internal/pkg/apps/install.go b/internal/pkg/apps/install.go index feaea2cc..b89ce904 100644 --- a/internal/pkg/apps/install.go +++ b/internal/pkg/apps/install.go @@ -17,7 +17,7 @@ package apps import ( "context" "fmt" - "os" + "path/filepath" "strings" "time" @@ -30,6 +30,7 @@ import ( "github.com/slackapi/slack-cli/internal/shared/types" "github.com/slackapi/slack-cli/internal/slackerror" "github.com/slackapi/slack-cli/internal/style" + "github.com/spf13/afero" ) // Constants for onlyCreateUpdateAppManifest parameter @@ -40,6 +41,23 @@ const ( const additionalManifestInfoNotice = "App manifest contains some components that may require additional information" +var supportedIconExtensions = []string{".png", ".jpg", ".jpeg", ".gif"} + +func resolveIconPath(fs afero.Fs, manifestIcon string) string { + if manifestIcon != "" { + return manifestIcon + } + for _, dir := range []string{"assets", "."} { + for _, ext := range supportedIconExtensions { + candidate := filepath.Join(dir, "icon"+ext) + if _, err := fs.Stat(candidate); err == nil { + return candidate + } + } + } + return "" +} + // Install installs the app to a team func Install(ctx context.Context, clients *shared.ClientFactory, auth types.SlackAuth, onlyCreateUpdateAppManifest bool, app types.App, orgGrantWorkspaceID string) (types.App, types.InstallState, error) { span, ctx := opentracing.StartSpanFromContext(ctx, "pkg.apps.install") @@ -218,15 +236,8 @@ func Install(ctx context.Context, clients *shared.ClientFactory, auth types.Slac } } - // upload icon, default to assets/icon.png or icon.png - var iconPath = slackManifest.Icon - if iconPath == "" { - if _, err := os.Stat("assets/icon.png"); !os.IsNotExist(err) { - iconPath = "assets/icon.png" - } else if _, err := os.Stat("icon.png"); !os.IsNotExist(err) { - iconPath = "icon.png" - } - } + // upload icon, default to assets/icon.{png,jpg,jpeg,gif} or icon.{png,jpg,jpeg,gif} + iconPath := resolveIconPath(clients.Fs, slackManifest.Icon) if iconPath != "" { err = updateIcon(ctx, clients, iconPath, app.AppID, token) if err != nil { @@ -526,14 +537,7 @@ func InstallLocalApp(ctx context.Context, clients *shared.ClientFactory, orgGran // upload icon for non-hosted apps (gated behind set-icon experiment) if clients.Config.WithExperimentOn(experiment.SetIcon) { - var iconPath = slackManifest.Icon - if iconPath == "" { - if _, err := os.Stat("assets/icon.png"); !os.IsNotExist(err) { - iconPath = "assets/icon.png" - } else if _, err := os.Stat("icon.png"); !os.IsNotExist(err) { - iconPath = "icon.png" - } - } + iconPath := resolveIconPath(clients.Fs, slackManifest.Icon) if iconPath != "" { _, iconErr := clients.API().IconSet(ctx, clients.Fs, token, app.AppID, iconPath) if iconErr != nil { diff --git a/internal/pkg/apps/install_test.go b/internal/pkg/apps/install_test.go index 2c44dc94..2be011a4 100644 --- a/internal/pkg/apps/install_test.go +++ b/internal/pkg/apps/install_test.go @@ -26,6 +26,7 @@ import ( "github.com/slackapi/slack-cli/internal/shared/types" "github.com/slackapi/slack-cli/internal/slackcontext" "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" @@ -1724,3 +1725,66 @@ func TestContinueDespiteWarning(t *testing.T) { }) } } + +func Test_resolveIconPath(t *testing.T) { + tests := map[string]struct { + manifestIcon string + files []string + expected string + }{ + "manifest icon set returns it directly": { + manifestIcon: "custom/my-icon.png", + expected: "custom/my-icon.png", + }, + "assets/icon.png found": { + files: []string{"assets/icon.png"}, + expected: "assets/icon.png", + }, + "assets/icon.jpg found": { + files: []string{"assets/icon.jpg"}, + expected: "assets/icon.jpg", + }, + "assets/icon.jpeg found": { + files: []string{"assets/icon.jpeg"}, + expected: "assets/icon.jpeg", + }, + "assets/icon.gif found": { + files: []string{"assets/icon.gif"}, + expected: "assets/icon.gif", + }, + "png wins over gif in assets": { + files: []string{"assets/icon.png", "assets/icon.gif"}, + expected: "assets/icon.png", + }, + "jpg wins over gif in assets": { + files: []string{"assets/icon.jpg", "assets/icon.gif"}, + expected: "assets/icon.jpg", + }, + "root icon.png found when no assets": { + files: []string{"icon.png"}, + expected: "icon.png", + }, + "root icon.jpg found when no assets": { + files: []string{"icon.jpg"}, + expected: "icon.jpg", + }, + "assets takes priority over root": { + files: []string{"assets/icon.gif", "icon.png"}, + expected: "assets/icon.gif", + }, + "no icon files returns empty": { + files: []string{}, + expected: "", + }, + } + for name, tc := range tests { + t.Run(name, func(t *testing.T) { + fs := afero.NewMemMapFs() + for _, f := range tc.files { + require.NoError(t, afero.WriteFile(fs, f, []byte("img"), 0o644)) + } + result := resolveIconPath(fs, tc.manifestIcon) + assert.Equal(t, tc.expected, result) + }) + } +} diff --git a/internal/shared/types/slack_yaml.go b/internal/shared/types/slack_yaml.go index 106135b2..1f8fea08 100644 --- a/internal/shared/types/slack_yaml.go +++ b/internal/shared/types/slack_yaml.go @@ -27,15 +27,19 @@ type SlackYaml struct { Hash string } +var supportedIconExtensions = []string{".png", ".jpg", ".jpeg", ".gif"} + // hasValidIconPath returns false if icon path is provided but is not valid and true otherwise func (sy *SlackYaml) hasValidIconPath() bool { - // verify icon path is valid if exists var wd, err = os.Getwd() if err == nil { - if sy.Icon == "" { // icon was not provided. Let's check if the default one exists - var defaultIconPath = "assets/icon.png" - if _, err := os.Stat(filepath.Join(wd, defaultIconPath)); !os.IsNotExist(err) { - sy.Icon = defaultIconPath + if sy.Icon == "" { + for _, ext := range supportedIconExtensions { + candidate := filepath.Join(wd, "assets", "icon"+ext) + if _, err := os.Stat(candidate); !os.IsNotExist(err) { + sy.Icon = filepath.Join("assets", "icon"+ext) + break + } } } else { if _, err := os.Stat(filepath.Join(wd, sy.Icon)); os.IsNotExist(err) { diff --git a/internal/shared/types/slack_yaml_test.go b/internal/shared/types/slack_yaml_test.go index f9264288..7276a284 100644 --- a/internal/shared/types/slack_yaml_test.go +++ b/internal/shared/types/slack_yaml_test.go @@ -50,6 +50,31 @@ func Test_SlackYaml_hasValidIconPath(t *testing.T) { }, expected: true, }, + "no icon with default assets/icon.jpg present returns true": { + icon: "", + setup: func(t *testing.T, dir string) { + require.NoError(t, os.MkdirAll(filepath.Join(dir, "assets"), 0o755)) + require.NoError(t, os.WriteFile(filepath.Join(dir, "assets", "icon.jpg"), []byte("img"), 0o644)) + }, + expected: true, + }, + "no icon with default assets/icon.gif present returns true": { + icon: "", + setup: func(t *testing.T, dir string) { + require.NoError(t, os.MkdirAll(filepath.Join(dir, "assets"), 0o755)) + require.NoError(t, os.WriteFile(filepath.Join(dir, "assets", "icon.gif"), []byte("img"), 0o644)) + }, + expected: true, + }, + "png takes priority over jpg in assets": { + icon: "", + setup: func(t *testing.T, dir string) { + require.NoError(t, os.MkdirAll(filepath.Join(dir, "assets"), 0o755)) + require.NoError(t, os.WriteFile(filepath.Join(dir, "assets", "icon.png"), []byte("img"), 0o644)) + require.NoError(t, os.WriteFile(filepath.Join(dir, "assets", "icon.jpg"), []byte("img"), 0o644)) + }, + expected: true, + }, "no icon and no default returns true": { icon: "", setup: func(t *testing.T, dir string) {}, From c9abb3046b301ad85f67a9402bd11d3857ecb1a8 Mon Sep 17 00:00:00 2001 From: Ale Mercado Date: Fri, 1 May 2026 11:33:48 -0400 Subject: [PATCH 3/3] refactor: extract icon resolution to internal/icon package Consolidate duplicated icon path resolution logic from install.go and slack_yaml.go into a shared internal/icon package per review feedback. --- internal/icon/icon.go | 38 +++++++++++ internal/icon/icon_test.go | 86 ++++++++++++++++++++++++ internal/pkg/apps/install.go | 24 +------ internal/pkg/apps/install_test.go | 64 ------------------ internal/shared/types/slack_yaml.go | 34 ++++------ internal/shared/types/slack_yaml_test.go | 7 +- 6 files changed, 145 insertions(+), 108 deletions(-) create mode 100644 internal/icon/icon.go create mode 100644 internal/icon/icon_test.go diff --git a/internal/icon/icon.go b/internal/icon/icon.go new file mode 100644 index 00000000..05a81e9e --- /dev/null +++ b/internal/icon/icon.go @@ -0,0 +1,38 @@ +// Copyright 2022-2026 Salesforce, Inc. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package icon + +import ( + "path/filepath" + + "github.com/spf13/afero" +) + +var SupportedExtensions = []string{".png", ".jpg", ".jpeg", ".gif"} + +func ResolveIconPath(fs afero.Fs, manifestIcon string) string { + if manifestIcon != "" { + return manifestIcon + } + for _, dir := range []string{"assets", "."} { + for _, ext := range SupportedExtensions { + candidate := filepath.Join(dir, "icon"+ext) + if _, err := fs.Stat(candidate); err == nil { + return candidate + } + } + } + return "" +} diff --git a/internal/icon/icon_test.go b/internal/icon/icon_test.go new file mode 100644 index 00000000..e694bc7c --- /dev/null +++ b/internal/icon/icon_test.go @@ -0,0 +1,86 @@ +// Copyright 2022-2026 Salesforce, Inc. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package icon + +import ( + "testing" + + "github.com/spf13/afero" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +func Test_ResolveIconPath(t *testing.T) { + tests := map[string]struct { + manifestIcon string + files []string + expected string + }{ + "manifest icon set returns it directly": { + manifestIcon: "custom/my-icon.png", + expected: "custom/my-icon.png", + }, + "assets/icon.png found": { + files: []string{"assets/icon.png"}, + expected: "assets/icon.png", + }, + "assets/icon.jpg found": { + files: []string{"assets/icon.jpg"}, + expected: "assets/icon.jpg", + }, + "assets/icon.jpeg found": { + files: []string{"assets/icon.jpeg"}, + expected: "assets/icon.jpeg", + }, + "assets/icon.gif found": { + files: []string{"assets/icon.gif"}, + expected: "assets/icon.gif", + }, + "png wins over gif in assets": { + files: []string{"assets/icon.png", "assets/icon.gif"}, + expected: "assets/icon.png", + }, + "jpg wins over gif in assets": { + files: []string{"assets/icon.jpg", "assets/icon.gif"}, + expected: "assets/icon.jpg", + }, + "root icon.png found when no assets": { + files: []string{"icon.png"}, + expected: "icon.png", + }, + "root icon.jpg found when no assets": { + files: []string{"icon.jpg"}, + expected: "icon.jpg", + }, + "assets takes priority over root": { + files: []string{"assets/icon.gif", "icon.png"}, + expected: "assets/icon.gif", + }, + "no icon files returns empty": { + files: []string{}, + expected: "", + }, + } + for name, tc := range tests { + t.Run(name, func(t *testing.T) { + fs := afero.NewMemMapFs() + for _, f := range tc.files { + require.NoError(t, afero.WriteFile(fs, f, []byte("img"), 0o644)) + } + result := ResolveIconPath(fs, tc.manifestIcon) + assert.Equal(t, tc.expected, result) + }) + } +} diff --git a/internal/pkg/apps/install.go b/internal/pkg/apps/install.go index b89ce904..29b5f5d0 100644 --- a/internal/pkg/apps/install.go +++ b/internal/pkg/apps/install.go @@ -17,7 +17,6 @@ package apps import ( "context" "fmt" - "path/filepath" "strings" "time" @@ -25,12 +24,12 @@ import ( "github.com/slackapi/slack-cli/internal/api" "github.com/slackapi/slack-cli/internal/config" "github.com/slackapi/slack-cli/internal/experiment" + "github.com/slackapi/slack-cli/internal/icon" "github.com/slackapi/slack-cli/internal/pkg/manifest" "github.com/slackapi/slack-cli/internal/shared" "github.com/slackapi/slack-cli/internal/shared/types" "github.com/slackapi/slack-cli/internal/slackerror" "github.com/slackapi/slack-cli/internal/style" - "github.com/spf13/afero" ) // Constants for onlyCreateUpdateAppManifest parameter @@ -41,23 +40,6 @@ const ( const additionalManifestInfoNotice = "App manifest contains some components that may require additional information" -var supportedIconExtensions = []string{".png", ".jpg", ".jpeg", ".gif"} - -func resolveIconPath(fs afero.Fs, manifestIcon string) string { - if manifestIcon != "" { - return manifestIcon - } - for _, dir := range []string{"assets", "."} { - for _, ext := range supportedIconExtensions { - candidate := filepath.Join(dir, "icon"+ext) - if _, err := fs.Stat(candidate); err == nil { - return candidate - } - } - } - return "" -} - // Install installs the app to a team func Install(ctx context.Context, clients *shared.ClientFactory, auth types.SlackAuth, onlyCreateUpdateAppManifest bool, app types.App, orgGrantWorkspaceID string) (types.App, types.InstallState, error) { span, ctx := opentracing.StartSpanFromContext(ctx, "pkg.apps.install") @@ -237,7 +219,7 @@ func Install(ctx context.Context, clients *shared.ClientFactory, auth types.Slac } // upload icon, default to assets/icon.{png,jpg,jpeg,gif} or icon.{png,jpg,jpeg,gif} - iconPath := resolveIconPath(clients.Fs, slackManifest.Icon) + iconPath := icon.ResolveIconPath(clients.Fs, slackManifest.Icon) if iconPath != "" { err = updateIcon(ctx, clients, iconPath, app.AppID, token) if err != nil { @@ -537,7 +519,7 @@ func InstallLocalApp(ctx context.Context, clients *shared.ClientFactory, orgGran // upload icon for non-hosted apps (gated behind set-icon experiment) if clients.Config.WithExperimentOn(experiment.SetIcon) { - iconPath := resolveIconPath(clients.Fs, slackManifest.Icon) + iconPath := icon.ResolveIconPath(clients.Fs, slackManifest.Icon) if iconPath != "" { _, iconErr := clients.API().IconSet(ctx, clients.Fs, token, app.AppID, iconPath) if iconErr != nil { diff --git a/internal/pkg/apps/install_test.go b/internal/pkg/apps/install_test.go index 2be011a4..2c44dc94 100644 --- a/internal/pkg/apps/install_test.go +++ b/internal/pkg/apps/install_test.go @@ -26,7 +26,6 @@ import ( "github.com/slackapi/slack-cli/internal/shared/types" "github.com/slackapi/slack-cli/internal/slackcontext" "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" @@ -1725,66 +1724,3 @@ func TestContinueDespiteWarning(t *testing.T) { }) } } - -func Test_resolveIconPath(t *testing.T) { - tests := map[string]struct { - manifestIcon string - files []string - expected string - }{ - "manifest icon set returns it directly": { - manifestIcon: "custom/my-icon.png", - expected: "custom/my-icon.png", - }, - "assets/icon.png found": { - files: []string{"assets/icon.png"}, - expected: "assets/icon.png", - }, - "assets/icon.jpg found": { - files: []string{"assets/icon.jpg"}, - expected: "assets/icon.jpg", - }, - "assets/icon.jpeg found": { - files: []string{"assets/icon.jpeg"}, - expected: "assets/icon.jpeg", - }, - "assets/icon.gif found": { - files: []string{"assets/icon.gif"}, - expected: "assets/icon.gif", - }, - "png wins over gif in assets": { - files: []string{"assets/icon.png", "assets/icon.gif"}, - expected: "assets/icon.png", - }, - "jpg wins over gif in assets": { - files: []string{"assets/icon.jpg", "assets/icon.gif"}, - expected: "assets/icon.jpg", - }, - "root icon.png found when no assets": { - files: []string{"icon.png"}, - expected: "icon.png", - }, - "root icon.jpg found when no assets": { - files: []string{"icon.jpg"}, - expected: "icon.jpg", - }, - "assets takes priority over root": { - files: []string{"assets/icon.gif", "icon.png"}, - expected: "assets/icon.gif", - }, - "no icon files returns empty": { - files: []string{}, - expected: "", - }, - } - for name, tc := range tests { - t.Run(name, func(t *testing.T) { - fs := afero.NewMemMapFs() - for _, f := range tc.files { - require.NoError(t, afero.WriteFile(fs, f, []byte("img"), 0o644)) - } - result := resolveIconPath(fs, tc.manifestIcon) - assert.Equal(t, tc.expected, result) - }) - } -} diff --git a/internal/shared/types/slack_yaml.go b/internal/shared/types/slack_yaml.go index 1f8fea08..6c0fc072 100644 --- a/internal/shared/types/slack_yaml.go +++ b/internal/shared/types/slack_yaml.go @@ -18,7 +18,9 @@ import ( "os" "path/filepath" + "github.com/slackapi/slack-cli/internal/icon" "github.com/slackapi/slack-cli/internal/slackerror" + "github.com/spf13/afero" ) type SlackYaml struct { @@ -27,33 +29,25 @@ type SlackYaml struct { Hash string } -var supportedIconExtensions = []string{".png", ".jpg", ".jpeg", ".gif"} - // hasValidIconPath returns false if icon path is provided but is not valid and true otherwise -func (sy *SlackYaml) hasValidIconPath() bool { - var wd, err = os.Getwd() - if err == nil { - if sy.Icon == "" { - for _, ext := range supportedIconExtensions { - candidate := filepath.Join(wd, "assets", "icon"+ext) - if _, err := os.Stat(candidate); !os.IsNotExist(err) { - sy.Icon = filepath.Join("assets", "icon"+ext) - break - } - } - } else { - if _, err := os.Stat(filepath.Join(wd, sy.Icon)); os.IsNotExist(err) { - return false - } +func (sy *SlackYaml) hasValidIconPath(fs afero.Fs) bool { + wd, err := os.Getwd() + if err != nil { + return true + } + if sy.Icon == "" { + sy.Icon = icon.ResolveIconPath(afero.NewBasePathFs(fs, wd), "") + } else { + if _, err := fs.Stat(filepath.Join(wd, sy.Icon)); os.IsNotExist(err) { + return false } } - return true } // Verify checks that the app manifest meets some basic requirements -func (sy *SlackYaml) Verify() error { - if !sy.hasValidIconPath() { +func (sy *SlackYaml) Verify(fs afero.Fs) error { + if !sy.hasValidIconPath(fs) { return slackerror.New("Please specify a valid icon path in app manifest") } return nil diff --git a/internal/shared/types/slack_yaml_test.go b/internal/shared/types/slack_yaml_test.go index 7276a284..e41584ad 100644 --- a/internal/shared/types/slack_yaml_test.go +++ b/internal/shared/types/slack_yaml_test.go @@ -19,6 +19,7 @@ import ( "path/filepath" "testing" + "github.com/spf13/afero" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" ) @@ -92,7 +93,7 @@ func Test_SlackYaml_hasValidIconPath(t *testing.T) { defer func() { require.NoError(t, os.Chdir(origDir)) }() sy := &SlackYaml{Icon: tc.icon} - assert.Equal(t, tc.expected, sy.hasValidIconPath()) + assert.Equal(t, tc.expected, sy.hasValidIconPath(afero.NewOsFs())) }) } } @@ -128,9 +129,9 @@ func Test_SlackYaml_Verify(t *testing.T) { sy := &SlackYaml{Icon: tc.icon} if tc.expectErr { - assert.Error(t, sy.Verify()) + assert.Error(t, sy.Verify(afero.NewOsFs())) } else { - assert.NoError(t, sy.Verify()) + assert.NoError(t, sy.Verify(afero.NewOsFs())) } }) }