Cb-tumblebug: Avoid importing pkg for gRPC (CB-Spider, CB-Dragonfly)

[seokho-son]

What would you like to be enhanced
CB-Spider, CB-Dragonfly 의 gRPC 인터페이스를 활용하기 위해서,
pkg 자체를 임포트하고 있어서,
go.mod go.sum 등을 통해서 불필요하게 자동 다운로드 되는 소스들이 발생함.

Please check @hermitkim1 's test
https://github.com/cloud-barista/cb-larva/discussions/141#discussioncomment-1569917

pkg 임포트를 하지 않고, 필요한 proto buffers 소스만 활용하여, CB-TB를 가볍게 만들 필요가 있음.

Proposed solution

1. CB-SP, CB-DF의 proto buffers 만 복사해서 내부적으로 활용
2. 필요에 따라 git submodule 활용 (주기적인 업데이트가 필요한 상황이 되면 추진)

[seokho-son]

@jihoon-seo could you help ? (not urgent issue at all)

[jihoon-seo]

["github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/logger" 를 import 하는 파일]

1. cb-tumblebug/src/api/grpc/cbadm/cmd/connectinfo.go
2. cb-tumblebug/src/api/grpc/cbadm/cmd/credential.go
3. cb-tumblebug/src/api/grpc/cbadm/cmd/driver.go
4. cb-tumblebug/src/api/grpc/cbadm/cmd/region.go

cbadm 코드들이네요.
cbadm 코드에서도 Spider 패키지를 import 하는 부분을 삭제하는 것이 좋을 것 같기도 합니다.

["github.com/cloud-barista/cb-spider/interface/api" 를 import 하는 파일]

1. cb-tumblebug/src/api/grpc/cbadm/cmd/gclient.go
2. cb-tumblebug/src/api/grpc/cbadm/proc/connectinfos.go
3. cb-tumblebug/src/api/grpc/request/test/test_api.go
4. cb-tumblebug/src/core/common/utility.go
5. cb-tumblebug/src/core/mcir/common.go
6. cb-tumblebug/src/core/mcir/image.go
7. cb-tumblebug/src/core/mcir/securitygroup.go
8. cb-tumblebug/src/core/mcir/spec.go
9. cb-tumblebug/src/core/mcir/sshkey.go
10. cb-tumblebug/src/core/mcir/subnet.go
11. cb-tumblebug/src/core/mcir/vnet.go
12. cb-tumblebug/src/core/mcis/control.go
13. cb-tumblebug/src/core/mcis/manageInfo.go
14. cb-tumblebug/src/core/mcis/provisioning.go

[jihoon-seo]

다음과 같이 해 보았습니다.

1. cb-tumblebug 아래에 submodules 디렉토리 생성
2. submodules 디렉토리 아래에서 git submodule add https://github.com/cloud-barista/cb-spider.git 실행
   
   
   
   • submodules 디렉토리 아래에 cb-spider repo가 클론되었음
   
   
   • cb-tumblebug 디렉토리에 .gitmodules 파일이 생성되었음
   
   

[submodule "submodules/cb-spider"]
        path = submodules/cb-spider
        url = https://github.com/cloud-barista/cb-spider.git

1. TB 소스코드에서,
   "github.com/cloud-barista/cb-spider/interface/api" 를
   "github.com/cloud-barista/cb-tumblebug/submodules/cb-spider/interface/api" 로 replace
2. 에러 발생 🤔

❯ make cbadm
cd api/grpc/cbadm && make
make[1]: 디렉터리 '/home/jhseo/go/src/github.com/cloud-barista/cb-tumblebug/src/api/grpc/cbadm' 들어감
go build -mod=mod -o cbadm
go: finding module for package github.com/cloud-barista/cb-tumblebug/submodules/cb-spider/interface/api
../../../core/common/utility.go:27:2: no matching versions for query "latest"
Makefile:2: recipe for target 'default' failed
make[1]: *** [default] Error 1
make[1]: 디렉터리 '/home/jhseo/go/src/github.com/cloud-barista/cb-tumblebug/src/api/grpc/cbadm' 나감
Makefile:10: recipe for target 'cbadm' failed
make: *** [cbadm] Error 2

❯ make      
go build -mod=mod -o cb-tumblebug
go: finding module for package github.com/cloud-barista/cb-tumblebug/submodules/cb-spider/interface/api
core/common/utility.go:27:2: no matching versions for query "latest"
Makefile:2: recipe for target 'default' failed
make: *** [default] Error 1

❯ go mod tidy                          
go: finding module for package github.com/cloud-barista/cb-tumblebug/submodules/cb-spider/interface/api
github.com/cloud-barista/cb-tumblebug/src/api/grpc/cbadm/cmd imports
        github.com/cloud-barista/cb-tumblebug/submodules/cb-spider/interface/api: no matching versions for query "latest"

[jihoon-seo]

TB의 go.mod 에 다음을 추가합니다.

require (
    github.com/cloud-barista/cb-tumblebug/submodules/cb-spider v0.0.0
)

replace (
    github.com/cloud-barista/cb-tumblebug/submodules/cb-spider => ./submodules/cb-spider
)

go mod tidy 를 실행합니다 => 실행 성공

make 하면 에러가 발생합니다.

❯ make
go build -mod=mod -o cb-tumblebug
# github.com/cloud-barista/cb-tumblebug/submodules/cb-spider/interface/api
../submodules/cb-spider/interface/api/ccm.go:867:23: ccm.requestCCM.RegisterVPC undefined (type *request.CCMRequest has no field or method RegisterVPC)
../submodules/cb-spider/interface/api/ccm.go:883:31: ccm.requestCCM.RegisterVPC undefined (type *request.CCMRequest has no field or method RegisterVPC)
../submodules/cb-spider/interface/api/ccm.go:896:23: ccm.requestCCM.UnregisterVPC undefined (type *request.CCMRequest has no field or method UnregisterVPC)
../submodules/cb-spider/interface/api/ccm.go:908:31: ccm.requestCCM.UnregisterVPC undefined (type *request.CCMRequest has no field or method UnregisterVPC)
../submodules/cb-spider/interface/api/ccm.go:1075:23: ccm.requestCCM.RegisterSecurity undefined (type *request.CCMRequest has no field or method RegisterSecurity)
../submodules/cb-spider/interface/api/ccm.go:1091:31: ccm.requestCCM.RegisterSecurity undefined (type *request.CCMRequest has no field or method RegisterSecurity)
../submodules/cb-spider/interface/api/ccm.go:1104:23: ccm.requestCCM.UnregisterSecurity undefined (type *request.CCMRequest has no field or method UnregisterSecurity)
../submodules/cb-spider/interface/api/ccm.go:1116:31: ccm.requestCCM.UnregisterSecurity undefined (type *request.CCMRequest has no field or method UnregisterSecurity)
../submodules/cb-spider/interface/api/ccm.go:1283:23: ccm.requestCCM.RegisterKey undefined (type *request.CCMRequest has no field or method RegisterKey)
../submodules/cb-spider/interface/api/ccm.go:1299:31: ccm.requestCCM.RegisterKey undefined (type *request.CCMRequest has no field or method RegisterKey)
../submodules/cb-spider/interface/api/ccm.go:1299:31: too many errors
Makefile:2: recipe for target 'default' failed
make: *** [default] Error 2

---

혹시나 해서 이렇게 수정해 봅니다.

require (
    github.com/cloud-barista/cb-tumblebug/submodules/cb-spider v0.4.13
)

replace (
    github.com/cloud-barista/cb-tumblebug/submodules/cb-spider => ./submodules/cb-spider
)

go mod tidy 를 실행합니다 => 실행 성공

make 하면 동일한 에러가 발생합니다.

❯ make
go build -mod=mod -o cb-tumblebug
# github.com/cloud-barista/cb-tumblebug/submodules/cb-spider/interface/api
../submodules/cb-spider/interface/api/ccm.go:867:23: ccm.requestCCM.RegisterVPC undefined (type *request.CCMRequest has no field or method RegisterVPC)
../submodules/cb-spider/interface/api/ccm.go:883:31: ccm.requestCCM.RegisterVPC undefined (type *request.CCMRequest has no field or method RegisterVPC)
../submodules/cb-spider/interface/api/ccm.go:896:23: ccm.requestCCM.UnregisterVPC undefined (type *request.CCMRequest has no field or method UnregisterVPC)
../submodules/cb-spider/interface/api/ccm.go:908:31: ccm.requestCCM.UnregisterVPC undefined (type *request.CCMRequest has no field or method UnregisterVPC)
../submodules/cb-spider/interface/api/ccm.go:1075:23: ccm.requestCCM.RegisterSecurity undefined (type *request.CCMRequest has no field or method RegisterSecurity)
../submodules/cb-spider/interface/api/ccm.go:1091:31: ccm.requestCCM.RegisterSecurity undefined (type *request.CCMRequest has no field or method RegisterSecurity)
../submodules/cb-spider/interface/api/ccm.go:1104:23: ccm.requestCCM.UnregisterSecurity undefined (type *request.CCMRequest has no field or method UnregisterSecurity)
../submodules/cb-spider/interface/api/ccm.go:1116:31: ccm.requestCCM.UnregisterSecurity undefined (type *request.CCMRequest has no field or method UnregisterSecurity)
../submodules/cb-spider/interface/api/ccm.go:1283:23: ccm.requestCCM.RegisterKey undefined (type *request.CCMRequest has no field or method RegisterKey)
../submodules/cb-spider/interface/api/ccm.go:1299:31: ccm.requestCCM.RegisterKey undefined (type *request.CCMRequest has no field or method RegisterKey)
../submodules/cb-spider/interface/api/ccm.go:1299:31: too many errors
Makefile:2: recipe for target 'default' failed
make: *** [default] Error 2

[seokho-son]

@jihoon-seo 일단 https://github.com/cloud-barista/cb-larva/discussions/141#discussioncomment-1569917 이런식으로 필요한 파일만 가져와서 빌드 확인해보면 어떨까요?

[seokho-son]

@jihoon-seo

Some refs using submodule for gRPC

• https://github.com/grpc/grpc/blob/master/.gitmodules , https://github.com/grpc/grpc/tree/master/third_party
• https://asuraiv.tistory.com/15

[jihoon-seo]

현재 TB에서는
SP의 *.pb.go 만을 이용하고 있는 것은 아니고
SP에 있는 gRPC client (= request) 코드를 import하여 사용하고 있기 때문에

'필요한 파일만 가져와서 빌드' 하려면
SP에 있는 gRPC client (= request) 코드 등을
TB 디렉토리 아래에 복사하여 사용해야 할 것 같습니다.

@seokho-son @hermitkim1 어떻게 생각하시나요? (제 추측이 맞는지..?) 😊

[jihoon-seo]

다음과 같이 해 보았습니다.

1. cb-tumblebug 아래에 first_party 디렉토리 생성
2. first_party 디렉토리 아래에 cb-spider/interface/api 디렉토리 생성
3. cb-spider/interface/api 디렉토리의 내용물을 cb-tumblebug/first_party/cb-spider/interface/api 디렉토리로 복사
4. go.mod 에 다음 항목 추가

replace (
    github.com/cloud-barista/cb-spider => ./first_party/cb-spider
)

1. cb-tumblebug/src 에서 go mod tidy 또는 make 실행 => 에러 발생

❯ go mod tidy
go: github.com/cloud-barista/[email protected] (replaced by ./first_party/cb-spider): reading ../first_party/cb-spider/go.mod: open /home/jhseo/go/src/github.com/cloud-barista/cb-tumblebug/first_party/cb-spider/go.mod: no such file or directory
go: github.com/cloud-barista/[email protected] (replaced by ./first_party/cb-spider): reading ../first_party/cb-spider/go.mod: open /home/jhseo/go/src/github.com/cloud-barista/cb-tumblebug/first_party/cb-spider/go.mod: no such file or directory

---

1. cb-tumblebug/first_party/cb-spider 디렉토리에서 go mod init & go mod tidy

❯ go mod init
go: creating new go.mod: module github.com/cloud-barista/cb-tumblebug/first_party/cb-spider
go: to add module requirements and sums:
        go mod tidy

❯ go mod tidy
go: finding module for package google.golang.org/grpc
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/logger
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/stub/cbspider
go: finding module for package github.com/cloud-barista/cb-spider/interface/api/request
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/common
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/config
go: finding module for package github.com/cloud-barista/cb-spider/interface/api
go: found github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/common in github.com/cloud-barista/cb-spider v0.4.14
go: found github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/config in github.com/cloud-barista/cb-spider v0.4.14
go: found github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/logger in github.com/cloud-barista/cb-spider v0.4.14
go: found github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/stub/cbspider in github.com/cloud-barista/cb-spider v0.4.14
go: found github.com/cloud-barista/cb-spider/interface/api/request in github.com/cloud-barista/cb-spider v0.4.14
go: found google.golang.org/grpc in google.golang.org/grpc v1.42.0
go: found github.com/cloud-barista/cb-spider/interface/api in github.com/cloud-barista/cb-spider v0.4.14

1. 다시 cb-tumblebug/src 에서 go mod tidy 또는 make 실행 => 에러 발생

❯ go mod tidy
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/config
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/stub/gogoproto
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/logger
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/stub/cbspider
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/common
go: finding module for package github.com/HdrHistogram/hdrhistogram-go
go: found github.com/HdrHistogram/hdrhistogram-go in github.com/HdrHistogram/hdrhistogram-go v1.1.2
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/common
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/stub/gogoproto
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/config
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/stub/cbspider
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/logger
github.com/cloud-barista/cb-tumblebug/src/api/grpc/cbadm/cmd imports
        github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/logger: module github.com/cloud-barista/cb-spider@latest found (v0.4.14, replaced by ./first_party/cb-spider), but does not contain package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/logger
github.com/cloud-barista/cb-tumblebug/src/api/grpc/cbadm/cmd imports
        github.com/cloud-barista/cb-spider/interface/api imports
        github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/common: module github.com/cloud-barista/cb-spider@latest found (v0.4.14, replaced by ./first_party/cb-spider), but does not contain package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/common
github.com/cloud-barista/cb-tumblebug/src/api/grpc/cbadm/cmd imports
        github.com/cloud-barista/cb-spider/interface/api imports
        github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/config: module github.com/cloud-barista/cb-spider@latest found (v0.4.14, replaced by ./first_party/cb-spider), but does not contain package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/config
github.com/cloud-barista/cb-tumblebug/src/api/grpc/cbadm/cmd imports
        github.com/cloud-barista/cb-spider/interface/api imports
        github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/stub/cbspider: module github.com/cloud-barista/cb-spider@latest found (v0.4.14, replaced by ./first_party/cb-spider), but does not contain package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/stub/cbspider
github.com/cloud-barista/cb-tumblebug/src/core/mcis imports
        github.com/cloud-barista/cb-dragonfly/pkg/api/grpc/protobuf/cbdragonfly imports
        github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/stub/gogoproto: module github.com/cloud-barista/cb-spider@latest found (v0.4.14, replaced by ./first_party/cb-spider), but does not contain package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/stub/gogoproto

❯ make
go build -mod=mod -o cb-tumblebug
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/stub/gogoproto
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/config
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/common
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/logger
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/stub/cbspider
../first_party/cb-spider/interface/api/ccm.go:17:2: module github.com/cloud-barista/cb-spider@latest found (v0.4.14, replaced by ./first_party/cb-spider), but does not contain package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/common
../first_party/cb-spider/interface/api/ccm.go:18:2: module github.com/cloud-barista/cb-spider@latest found (v0.4.14, replaced by ./first_party/cb-spider), but does not contain package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/config
../first_party/cb-spider/interface/api/ccm.go:19:2: module github.com/cloud-barista/cb-spider@latest found (v0.4.14, replaced by ./first_party/cb-spider), but does not contain package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/logger
../first_party/cb-spider/interface/api/ccm.go:20:2: module github.com/cloud-barista/cb-spider@latest found (v0.4.14, replaced by ./first_party/cb-spider), but does not contain package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/stub/cbspider
/home/jhseo/go/pkg/mod/github.com/cloud-barista/[email protected]/pkg/api/grpc/protobuf/cbdragonfly/cbdragonfly.pb.go:10:2: module github.com/cloud-barista/cb-spider@latest found (v0.4.14, replaced by ./first_party/cb-spider), but does not contain package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/stub/gogoproto
Makefile:2: recipe for target 'default' failed
make: *** [default] Error 1

---

다음 계획: 없다고 뜨는 패키지들을 cb-tumblebug/first_party/cb-spider 아래로 복사하고
다시 go mod tidy 또는 make 실행

[jihoon-seo]

• cb-spider/api-runtime/grpc-runtime/common
• cb-spider/api-runtime/grpc-runtime/config
• cb-spider/api-runtime/grpc-runtime/logger
• cb-spider/api-runtime/grpc-runtime/stub/cbspider
• cb-spider/api-runtime/grpc-runtime/stub/gogoproto

위 디렉토리의 내용물들을 cb-tumblebug/first_party/cb-spider/ 아래로 복사하고
다시 go mod tidy 또는 make 실행 => 에러 발생

❯ go mod tidy
go: finding module for package github.com/HdrHistogram/hdrhistogram-go
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/interceptors/authjwt
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/interceptors/jaegertracer
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/interceptors/accesslog
go: found github.com/HdrHistogram/hdrhistogram-go in github.com/HdrHistogram/hdrhistogram-go v1.1.2
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/interceptors/jaegertracer
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/interceptors/authjwt
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/interceptors/accesslog
github.com/cloud-barista/cb-tumblebug/src/api/grpc/cbadm/cmd imports
        github.com/cloud-barista/cb-spider/interface/api imports
        github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/common imports
        github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/interceptors/accesslog: module github.com/cloud-barista/cb-spider@latest found (v0.4.14, replaced by ./first_party/cb-spider), but does not contain package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/interceptors/accesslog
github.com/cloud-barista/cb-tumblebug/src/api/grpc/cbadm/cmd imports
        github.com/cloud-barista/cb-spider/interface/api imports
        github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/common imports
        github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/interceptors/authjwt: module github.com/cloud-barista/cb-spider@latest found (v0.4.14, replaced by ./first_party/cb-spider), but does not contain package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/interceptors/authjwt
github.com/cloud-barista/cb-tumblebug/src/api/grpc/cbadm/cmd imports
        github.com/cloud-barista/cb-spider/interface/api imports
        github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/common imports
        github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/interceptors/jaegertracer: module github.com/cloud-barista/cb-spider@latest found (v0.4.14, replaced by ./first_party/cb-spider), but does not contain package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/interceptors/jaegertracer

❯ make
go build -mod=mod -o cb-tumblebug
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/interceptors/jaegertracer
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/interceptors/authjwt
go: finding module for package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/interceptors/accesslog
../first_party/cb-spider/api-runtime/grpc-runtime/common/cbconnection.go:21:2: module github.com/cloud-barista/cb-spider@latest found (v0.4.14, replaced by ./first_party/cb-spider), but does not contain package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/interceptors/accesslog
../first_party/cb-spider/api-runtime/grpc-runtime/common/cbconnection.go:22:2: module github.com/cloud-barista/cb-spider@latest found (v0.4.14, replaced by ./first_party/cb-spider), but does not contain package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/interceptors/authjwt
../first_party/cb-spider/api-runtime/grpc-runtime/common/cbconnection.go:18:2: module github.com/cloud-barista/cb-spider@latest found (v0.4.14, replaced by ./first_party/cb-spider), but does not contain package github.com/cloud-barista/cb-spider/api-runtime/grpc-runtime/interceptors/jaegertracer
Makefile:2: recipe for target 'default' failed
make: *** [default] Error 1

---

같은 작업을 한번 더 수행

• cb-spider/api-runtime/grpc-runtime/interceptors/jaegertracer
• cb-spider/api-runtime/grpc-runtime/interceptors/authjwt
• cb-spider/api-runtime/grpc-runtime/interceptors/accesslog

위 디렉토리의 내용물들을 cb-tumblebug/first_party/cb-spider/ 아래로 복사하고
다시 go mod tidy 또는 make 실행 => 둘 다 성공 😊