contexts

Documentation

Overview

Copyright 2021 The NitroCI Authors.

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.

Copyright 2021 The NitroCI Authors.

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.

Copyright 2021 The NitroCI Authors.

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.

Copyright 2021 The NitroCI Authors.

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.

Copyright 2021 The NitroCI Authors.

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.

Index

• Constants
• type CliContext
• type RuntimeContext
  • func LoadRuntimeContext(profile string, environment string, workspaceDepth int, verbose bool) (*RuntimeContext, error)
  • func (r *RuntimeContext) GetCurrentWorkspace() (*WorkspaceContext, error)
  • func (r *RuntimeContext) GetWorkspace(workspaceDepth int) (*WorkspaceContext, error)
  • func (r *RuntimeContext) GetWorkspaces() ([]*WorkspaceContext, error)
  • func (r *RuntimeContext) HasWorkspaces() bool
• type VirtualContext
• type WorkspaceContext
  • func (v *WorkspaceContext) CreateWorkspaceInstance() (*pkgWorkspaces.WorkspaceModel, error)

Constants

const (
	EXTENSION_INI_TYPE = "INI"
	EXTENSION_YML_TYPE = "YML"
	EXTENSION_TYPES    = EXTENSION_INI_TYPE + "," + EXTENSION_YML_TYPE
)

const (
	ENV_NAME_CONFIG           = "NITROCI_CONFIG"
	ENV_NAME_CACHE_HOME       = "NITROCI_CACHE"
	ENV_NAME_PLUGINS_REGISTRY = "NITROCI_PLUGINS_REGISTRY" // GITHUB+https://raw.githubusercontent.com/nitroci/nitroci-plugins/main
	ENV_NAME_WKS_FILE_FOLDER  = "NITROCI_WKS_FILE_FOLDER"  // GITHUB+https://raw.githubusercontent.com/nitroci/nitroci-bits/main
	ENV_NAME_WKS_FILE_NAME    = "NITROCI_WKS_FILE_NAME"
	ENV_NAME_BITS_REGISTRY    = "NITROCI_BITS_REGISTRY"
)

Configuration keys

const (
	CFG_DEFVAL_PLUGINS_REGISTRY_GITHUB_URL = "GITHUB+https://raw.githubusercontent.com/nitroci/nitroci-plugins/main"
	CFG_DEFVAL_WKS_FILE_FOLDER             = ".nitroci"
	CFG_DEFVAL_WKS_FILE_NAME               = "workspace.yml"
	CFG_DEFVAL_BITS_REGISTRY_GITHUB_URL    = "GITHUB+https://raw.githubusercontent.com/nitroci/nitroci-bits/main"
)

Default configuration values

const (
	CFG_NAME_CONFIG_PATH = "NITROCI_CONFIG"
	CFG_NAME_CONFIG_HOME = "NITROCI_CONFIG_HOME"
	CFG_NAME_CONFIG_FILE = "NITROCI_CONFIG_FILE"
	CFG_NAME_CONFIG_TYPE = "NITROCI_CONFIG_TYPE"

	CFG_NAME_CACHE_PATH         = "NITROCI_CACHE"
	CFG_NAME_CACHE_PLUGINS_PATH = "NITROCI_CACHE_PLUGINS"
	CFG_NAME_CACHE_BITS_PATH    = "NITROCI_CACHE_BITS"

	CFG_NAME_PLUGINS_REGISTRY = "NITROCI_PLUGINS_REGISTRY_URI"

	CFG_NAME_WKS_FILE_FOLDER = "NITROCI_WKS_FILE_FOLDER"
	CFG_NAME_WKS_FILE_NAME   = "NITROCI_WKS_FILE_NAME"

	CFG_NAME_BITS_REGISTRY = "NITROCI_BITS_REGISTRY_URI"
)

Keys for calculated configurations

Types

type CliContext

type CliContext struct {
	WorkingDirectory string
	Profile          string
	Environment      string
	WorkspaceDepth   int
	Settings         map[string]string
	Verbose          bool
	Goos             string
	Goarch           string
}

type RuntimeContext

type RuntimeContext struct {
	Cli     *CliContext
	Virtual *VirtualContext
}

func LoadRuntimeContext

func LoadRuntimeContext(profile string, environment string, workspaceDepth int, verbose bool) (*RuntimeContext, error)

func (*RuntimeContext) GetCurrentWorkspace

func (r *RuntimeContext) GetCurrentWorkspace() (*WorkspaceContext, error)

func (*RuntimeContext) GetWorkspace

func (r *RuntimeContext) GetWorkspace(workspaceDepth int) (*WorkspaceContext, error)

func (*RuntimeContext) GetWorkspaces

func (r *RuntimeContext) GetWorkspaces() ([]*WorkspaceContext, error)

func (*RuntimeContext) HasWorkspaces

func (r *RuntimeContext) HasWorkspaces() bool

type VirtualContext

type VirtualContext struct {
	Workspaces []*WorkspaceContext
}

type WorkspaceContext

type WorkspaceContext struct {
	WorkspacePath       string
	WorkspaceHome       string
	WorkspaceFileFolder string
	WorkspaceFile       string
	Version             int
	Id                  string
	Name                string
}

func (*WorkspaceContext) CreateWorkspaceInstance

func (v *WorkspaceContext) CreateWorkspaceInstance() (*pkgWorkspaces.WorkspaceModel, error)