| // Licensed to the Apache Software Foundation (ASF) under one or more |
| // contributor license agreements. See the NOTICE file distributed with |
| // this work for additional information regarding copyright ownership. |
| // The ASF licenses this file to You 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 appname provides containers for named applications. |
| // |
| // Application name foo-bar translate to environment variable prefix FOO_BAR_. |
| package appname |
| |
| import ( |
| "context" |
| "errors" |
| "fmt" |
| "net" |
| "os" |
| "path/filepath" |
| ) |
| |
| import ( |
| "github.com/apache/dubbo-kubernetes/pkg/bufman/pkg/app" |
| "github.com/apache/dubbo-kubernetes/pkg/bufman/pkg/encoding" |
| ) |
| |
| const ( |
| configFileName = "config.yaml" |
| secretRelDirPath = "secrets" |
| ) |
| |
| // Container is a container. |
| type Container interface { |
| // AppName is the application name. |
| // |
| // The name must be in [a-zA-Z0-9-_]. |
| AppName() string |
| // ConfigDirPath is the config directory path for the named application. |
| // |
| // First checks for $APP_NAME_CONFIG_DIR. |
| // If this is not set, uses app.ConfigDirPath()/app-name. |
| // Unnormalized. |
| ConfigDirPath() string |
| // CacheDirPath is the cache directory path for the named application. |
| // |
| // First checks for $APP_NAME_CACHE_DIR. |
| // If this is not set, uses app.CacheDirPath()/app-name. |
| // Unnormalized. |
| CacheDirPath() string |
| // DataDirPath is the data directory path for the named application. |
| // |
| // First checks for $APP_NAME_DATA_DIR. |
| // If this is not set, uses app.DataDirPath()/app-name. |
| // Unnormalized. |
| DataDirPath() string |
| // Port is the port to use for serving. |
| // |
| // First checks for $APP_NAME_PORT. |
| // If this is not set, checks for $PORT. |
| // If this is not set, returns 0, which means no port is known. |
| // Returns error on parse. |
| Port() (uint16, error) |
| } |
| |
| // NewContainer returns a new Container. |
| // |
| // The name must be in [a-zA-Z0-9-_]. |
| func NewContainer(envContainer app.EnvContainer, name string) (Container, error) { |
| return newContainer(envContainer, name) |
| } |
| |
| // ReadConfig reads the configuration from the YAML configuration file config.yaml |
| // in the configuration directory. |
| // |
| // If the file does not exist, this is a no-op. |
| // The value should be a pointer to unmarshal into. |
| func ReadConfig(container Container, value interface{}) error { |
| configFilePath := filepath.Join(container.ConfigDirPath(), configFileName) |
| data, err := os.ReadFile(configFilePath) |
| if !errors.Is(err, os.ErrNotExist) { |
| if err != nil { |
| return fmt.Errorf("could not read %s configuration file at %s: %w", container.AppName(), configFilePath, err) |
| } |
| if err := encoding.UnmarshalYAMLStrict(data, value); err != nil { |
| return fmt.Errorf("invalid %s configuration file: %w", container.AppName(), err) |
| } |
| } |
| return nil |
| } |
| |
| // ReadSecret returns the contents of the file at path |
| // filepath.Join(container.ConfigDirPath(), secretRelDirPath, name). |
| func ReadSecret(container Container, name string) (string, error) { |
| secretFilePath := filepath.Join(container.ConfigDirPath(), secretRelDirPath, name) |
| data, err := os.ReadFile(secretFilePath) |
| if err != nil { |
| return "", fmt.Errorf("failed to read secret at %s: %w", secretFilePath, err) |
| } |
| return string(data), nil |
| } |
| |
| // WriteConfig writes the configuration to the YAML configuration file config.yaml |
| // in the configuration directory. |
| // |
| // The directory is created if it does not exist. |
| // The value should be a pointer to marshal. |
| func WriteConfig(container Container, value interface{}) error { |
| data, err := encoding.MarshalYAML(value) |
| if err != nil { |
| return err |
| } |
| if err := os.MkdirAll(container.ConfigDirPath(), 0o755); err != nil { |
| return err |
| } |
| configFilePath := filepath.Join(container.ConfigDirPath(), configFileName) |
| fileMode := os.FileMode(0o644) |
| // OK to use os.Stat instead of os.Lstat here |
| if fileInfo, err := os.Stat(configFilePath); err == nil { |
| fileMode = fileInfo.Mode() |
| } |
| return os.WriteFile(configFilePath, data, fileMode) |
| } |
| |
| // Listen listens on the container's port, falling back to defaultPort. |
| func Listen(ctx context.Context, container Container, defaultPort uint16) (net.Listener, error) { |
| port, err := container.Port() |
| if err != nil { |
| return nil, err |
| } |
| if port == 0 { |
| port = defaultPort |
| } |
| // Must be 0.0.0.0 |
| var listenConfig net.ListenConfig |
| return listenConfig.Listen(ctx, "tcp", fmt.Sprintf("0.0.0.0:%d", port)) |
| } |