Cb-tumblebug: Enhance some codes

Created on 30 Aug 2021  路  4Comments  路  Source: cloud-barista/cb-tumblebug

What would you like to be enhanced
:

https://github.com/cloud-barista/cb-tumblebug/blob/main/src/core/mcis/orchestration.go

[As-is]

const (
    // AutoStatusReady is const for "Ready" status.
    AutoStatusReady string = "Ready"
    // AutoStatusChecking is const for "Checking" status.
    AutoStatusChecking string = "Checking"
    // AutoStatusDetected is const for "Detected" status.
    AutoStatusDetected string = "Detected"
    // AutoStatusOperating is const for "Operating" status.
    AutoStatusOperating string = "Operating"
    // AutoStatusStabilizing is const for "Stabilizing" status.
    AutoStatusStabilizing string = "Stabilizing"
    // AutoStatusTimeout is const for "Timeout" status.
    AutoStatusTimeout string = "Timeout"
    // AutoStatusError is const for "Failed" status.
    AutoStatusError string = "Failed"
    // AutoStatusSuspended is const for "Suspended" status.
    AutoStatusSuspended string = "Suspended"
)

// Action for mcis automation
const (
    // AutoActionScaleOut is const for "ScaleOut" action.
    AutoActionScaleOut string = "ScaleOut"
    // AutoActionScaleIn is const for "ScaleIn" action.
    AutoActionScaleIn string = "ScaleIn"
)

I think that each comment line is too obvious,
but they are needed to suppress some Go lint suggestions. 馃槉

[To-be]

const (
    // AutoStatusReady is const for "Ready" status.
    AutoStatusReady string = "Ready"

    // AutoStatusChecking is const for "Checking" status.
    AutoStatusChecking string = "Checking"

    // AutoStatusDetected is const for "Detected" status.
    AutoStatusDetected string = "Detected"

    // AutoStatusOperating is const for "Operating" status.
    AutoStatusOperating string = "Operating"

    // AutoStatusStabilizing is const for "Stabilizing" status.
    AutoStatusStabilizing string = "Stabilizing"

    // AutoStatusTimeout is const for "Timeout" status.
    AutoStatusTimeout string = "Timeout"

    // AutoStatusError is const for "Failed" status.
    AutoStatusError string = "Failed"

    // AutoStatusSuspended is const for "Suspended" status.
    AutoStatusSuspended string = "Suspended"
)

// Action for mcis automation
const (
    // AutoActionScaleOut is const for "ScaleOut" action.
    AutoActionScaleOut string = "ScaleOut"

    // AutoActionScaleIn is const for "ScaleIn" action.
    AutoActionScaleIn string = "ScaleIn"
)

Inserting some line breaks will improve the readability. 馃槉


https://github.com/cloud-barista/cb-tumblebug/blob/main/src/core/mcis/control.go

[As-is]

// const ActionCreate
const ActionCreate string = "Create"

// const ActionTerminate
const ActionTerminate string = "Terminate"

// const ActionSuspend
const ActionSuspend string = "Suspend"

// const ActionResume
const ActionResume string = "Resume"

// const ActionReboot
const ActionReboot string = "Reboot"

// const ActionComplete
const ActionComplete string = "None"

// const StatusRunning
const StatusRunning string = "Running"

// const StatusSuspended
const StatusSuspended string = "Suspended"

// const StatusFailed
const StatusFailed string = "Failed"

// const StatusTerminated
const StatusTerminated string = "Terminated"

// const StatusCreating
const StatusCreating string = "Creating"

// const StatusSuspending
const StatusSuspending string = "Suspending"

// const StatusResuming
const StatusResuming string = "Resuming"

// const StatusRebooting
const StatusRebooting string = "Rebooting"

// const StatusTerminating
const StatusTerminating string = "Terminating"

// const StatusUndefined
const StatusUndefined string = "Undefined"

// const StatusComplete
const StatusComplete string = "None"

[To-be]

const (
    // ActionCreate is const for ...
    ActionCreate string = "Create"

    // ActionTerminate is const for ...
    ActionTerminate string = "Terminate"

    // 
    ActionSuspend string = "Suspend"

    // 
    ActionResume string = "Resume"

    // 
    ActionReboot string = "Reboot"

    // 
    ActionComplete string = "None"
)

const (
    // 
    StatusRunning string = "Running"

    // 
    StatusSuspended string = "Suspended"

    // 
    StatusFailed string = "Failed"

    // 
    StatusTerminated string = "Terminated"

    // 
    StatusCreating string = "Creating"

    // 
    StatusSuspending string = "Suspending"

    // 
    StatusResuming string = "Resuming"

    // 
    StatusRebooting string = "Rebooting"

    // 
    StatusTerminating string = "Terminating"

    // 
    StatusUndefined string = "Undefined"

    // 
    StatusComplete string = "None"
)

https://github.com/cloud-barista/cb-tumblebug/blob/main/src/core/mcis/monitor.go

[As-is]

const monMetricAll string = "all"
const monMetricCpu string = "cpu"
const monMetricCpufreq string = "cpufreq"
const monMetricMem string = "mem"
const monMetricNet string = "net"
const monMetricSwap string = "swap"
const monMetricDisk string = "disk"
const monMetricDiskio string = "diskio"

[To-be]

const (
    monMetricAll string = "all"
    monMetricCpu string = "cpu"
    monMetricCpufreq string = "cpufreq"
    monMetricMem string = "mem"
    monMetricNet string = "net"
    monMetricSwap string = "swap"
    monMetricDisk string = "disk"
    monMetricDiskio string = "diskio"
)

Why is this needed
:
To make CB-Tumblebug source code more neat 馃槉

Proposed solution
:

enhancement good first issue

Most helpful comment

Hi, I'd like to start my contribution in golang projects by this issue, can I work on it?

All 4 comments

Hi, I'd like to start my contribution in golang projects by this issue, can I work on it?

Of course @HassanAlsamahi ~ ! :)

You can follow the suggestions from @jihoon-seo . (Please check "[to-be]" section.)
(Message to @jihoon-seo : could you change contents of this issue in English ? to help the first time contributor.)

This issue is easy to resolve and not affect to main logic. So, you can do this intuitively :)

I am not sure you are familiar with git and github, the following items are basic tasks for a contribution.

  • [ ] fork, clone this repo
  • [ ] set build environments
  • [ ] change source code as suggested
  • [ ] build cb-tumblebug to check build error :)
  • [ ] start cb-tumblebug server
  • [ ] open PR

If you face any difficulty, let us know. We are willing to help ;)

By the way, this project is initiated from Korea. So you need to know that this repository is still hosting Korean contents. (we hope to internationalize this project in future) Please check https://github.com/cloud-barista/cb-tumblebug#development-stage-of-cloud-barista regarding local language (Korean).

@HassanAlsamahi @seokho-son
I updated the content of this issue into English.
Thank you for your interest and contribution! 馃槉

Thanks very much for giving me this opportunity, and your support.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

seokho-son picture seokho-son  路  5Comments

seokho-son picture seokho-son  路  3Comments

seokho-son picture seokho-son  路  5Comments

seokho-son picture seokho-son  路  3Comments

jihoon-seo picture jihoon-seo  路  4Comments