인터페이스와 무관한 핵심 로직 분리

[singsangssong]

🔍 Description

• 환경변수 정리 #22
• arcus-cli의 방향이 '형상 관리 방식'과 '명령형 방식' 2가지로 논의중에 있으며, 현재 명령형 인터페이스의 핵심 로직은 cmd패키지의 각 명령 파일 내에 직접 구현되어 있습니다. 핵심 로직이 선언형 인터페이스 및 형상 관리 방식으로 구현된다면, 이전에 구현했던 코드들의 재사용이 어렵게 됩니다.
• 이에 필수적으로 포함되는 기능을 정리하고, 해당 기능들을 internal패키지에서 인터페이스와 무관하게 동작가능한 함수로 구현하고자 합니다.
  • 이를 통해, 'cmd'패키지는 사용자의 입력을 파싱하고 internal패키지 함수를 호출하는 역할만 담당하도록 합니다.

⏰ Implementation Idea

• Arcus-CLI 가이드 문서에 정리된 명령어를 기반으로 구현합니다.
• internal/zookeeper.go: znode를 관리하는 메서드
• internal/ssh.go: ssh 접속을 관리하는 메서드(ex: 프로세스 구동/중지, 파일 생성)

[singsangssong]

internal/zookeeper.go

// zkList 주소에 기반한 zk 연결
ContextWithZkConn(ctx context.Context, zkList []string, user, password string) (context.Context, error)
// Arcus 운영을 위한 기본 znode 초기화
InitializeArcusZnodes(zkConn *zk.Conn) error
// 전역 설정을 생성 or 업데이트합니다.
SetClusterConfig(zkConn *zk.Conn, serviceCode, config string) error
// serviceCode의 특정 서버 znode 생성
AddServerToServiceCode(zkConn *zk.Conn, serviceCode, serverAddr string) error
// serviceCode의 특정 서버 znode 삭제
RemoveServerFromServiceCode(zkConn *zk.Conn, serviceCode, serverAddr string) error
// serviceCode 및 관련 모든 znode 삭제
RemoveAllFromServiceCode(zkConn *zk.Conn, serviceCode string) error
// 특정 서비스코드의 서버 목록 및 실시간 서버 출력(Status -> interface)
GetServiceCodeStatus(zkConn *zk.Conn, serviceCode string) (*Status, error)
// acl 그룹 생성하기
CreateAclGroup(zkConn *zk.Conn, zkAcl *zk.ACL, groupName string)
// acl 그룹 삭제하기
RemoveAclGroup(zkConn *zk.Conn, zkAcl *zk.ACL, groupName string)
// acl 그룹 리스트 출력하기
ListAclGroup(zkConn *zk.Conn)
// acl 유저 생성하기
CreateAclUser(zkConn *zk.Conn, zkAcl *zk.ACL, groupName, userSpec string)
// acl 유저 삭제하기
RemoveAclUser(zkConn *zk.Conn, zkAcl *zk.ACL, groupName, user string)
// acl 유저 리스트 출력하기
ListAclUser(zkConn *zk.Conn, zkAcl *zk.ACL, groupName string)

internal/ssh.go

// memcached 프로세스 1개 구동
StartMemcachedProcess(zkList []string, ip, port, arcusPath string)
// memcached 프로세스 1개 중지
StopMemcachedProcess(ip, port, arcusPath string)
// ZK 프로세스 1개 구동
StartZKProcess(ip, zkPath string)
// ZK 프로세스 1개 중지
StopZKProcess(ip, zkPath string) error
// 원격 장비 1개에 myid, zoo.cfg 파일 생성
ConfigureZKFiles(ip, port, zkPath string, myid int, zkList []string) error

[namsic]

• ContextWithZkConn: zkList => zkServers로 합시다. (zk 쪽 인자가 zk.Connect(servers []string, …이므로)
• CreateAclUser: userSpec => (userName, password, perm) 분리합시다.
• RemoveAclGroup, RemoveAclUser, ListAclUser: zkAcl 없어도 되지 않나 생각합니다.
• StartMemcachedProcess: host, path, options 정도로 받고, zk에서 조회하는 등의 동작은 미리 해서 넘겨주는 것이 나아 보입니다.

[singsangssong]

• CreateAclUser: userSpec => (userName, password, perm) 분리합시다.

• 사실 userSpec의 경우, 인자가 너무 많아지는거 같아서 로직 내부에서 분리하려고 했습니다. 인자가 6개가 되는데 괜찮을까요?
• 만약 선언형(형상 관리) 방식을 유지한다면, 비밀번호를 받는 것에 관해서도 고민해봐야 할 것 같습니다.

위 Issue를 처리할때 zookeeper, acl, memcached 묶음으로 나눠서 PR을 올리려고하는데 괜찮을까요? 아니면 파일단위로 PR을 올릴까요?

[namsic]

사실 userSpec의 경우, 인자가 너무 많아지는거 같아서 로직 내부에서 분리하려고 했습니다. 인자가 6개가 되는데 괜찮을까요?

인자가 많아지더라도 구분을 명확히 하는 것이 좋겠습니다.
내부에서 Split 하게 되면 파싱 과정에서 invalid format에 대한 검사 및 예외 처리를 추가로 해야 합니다.
인자가 많은 것이 정 걸리면 UserSpec 구조체를 두어 이를 인자로 받도록 할 수 있습니다.

만약 선언형(형상 관리) 방식을 유지한다면, 비밀번호를 받는 것에 관해서도 고민해봐야 할 것 같습니다.

#26 에서 다루면 될 것 같고, yaml에 password 필드가 있으면 사용, 없으면 입력받는 등의 방식이 될 것으로 예상합니다.
그와 무관하게 internal에서는 자체적으로 입력을 받거나 하는 로직은 제외하고,
외부에서 비밀번호를 입력받는 등의 작업을 모두 처리하여 넘겨주는 것을 전제로 합시다.

위 Issue를 처리할때 zookeeper, acl, memcached 묶음으로 나눠서 PR을 올리려고하는데 괜찮을까요? 아니면 파일단위로 PR을 올릴까요?

분량이 어떻게 되는지 잘 몰라서 판단하기 어렵습니다. 편한대로 올려주면 확인하고 필요 시 분리/통합 요청하겠습니다.

[singsangssong]

현재 구현 자체는 마무리된 상태인데, 앞으로 선언형 인터페이스 도입까지 고려하여 internal 패키지의 디렉터리 구조를 개선하는 것에 대해 의견이 궁금합니다.

현재 internal 패키지는 아래와 같은 구조를 이루고 있습니다.

AS-IS

internal/
├── scram/
├── ssh.go
└── zookeeper.go

이 구조의 문제점은, zookeeper.go 파일 하나가 ACL 관리, Memcached 관리, 기본 Znode 초기화 등 서로 다른 여러 책임을 동시에 처리하고 있다는 것입니다. 게다가 다양한 type과 const 변수까지 섞이면서, 코드의 복잡도가 높아진 모습입니다.

이에, 각 기능의 역할을 명확히 분리하기 위해 아래와 같은 구조로 리팩토링하는 것을 제안합니다.

TO-BE

internal/
├── acl/         # ACL 그룹/사용자 관련 ZK 로직
├── memcached/   # Memcached 서비스/서버 관련 ZK 로직
├── ssh/         # SSH 연결 및 원격 실행 로직
├── types/       # Status, UserInfo 등 공용 구조체
└── zookeeper/   # ZK 기본 연결 및 znode 초기화 로직

• 각 패키지가 하나의 명확한 책임만 갖게 되어 코드의 가독성과 유지보수성이 향상됩니다.
• 앞으로 선언형 인터페이스에서 함수를 불러 사용할때, internal.으로 시작하기보다는 각 페키지를 구체화함으로 선언하는 함수의 동작을 명확히하고, 핵심 로직이 명확하게 분리되어 있어 향후 다른 기능이 추가되더라도 한 파일에 여러 책임을 맡은 함수가 섞이지 않아 코드 가독성이 매우 좋아집니다.

구체적인 내부 함수

• internal/acl/

package acl

func AddGroup(zkConn *zk.Conn, zkAcl []zk.ACL, groupName string) error { /* ... */ }
func RemoveGroup(zkConn *zk.Conn, groupName string) error { /* ... */ }
func GetGroups(zkConn *zk.Conn) ([]string, error) { /* ... */ }
func AddUser(zkConn *zk.Conn, zkAcl []zk.ACL, groupName, userName, password, role string) error { /* ... */ }
func RemoveUser(zkConn *zk.Conn, groupName, userName string) error { /* ... */ }
func GetUsers(zkConn *zk.Conn, groupName string) ([]UserInfo, error) { /* ... */ }

• internal/memcached/

package memcached

func SetClusterConfig(zkConn *zk.Conn, serviceCode, config string) error { /* ... */ }
func AddServerToService(zkConn *zk.Conn, serviceCode, serverAddr string) error { /* ... */ }
func RemoveServerFromService(zkConn *zk.Conn, serviceCode, serverAddr string) error { /* ... */ }
func RemoveAllFromService(zkConn *zk.Conn, serviceCode string) error { /* ... */ }
func GetServiceStatus(zkConn *zk.Conn, serviceCode string) (*Status, error) { /* ... */ }
func StatMemcachedProcess(ip, arcusPath string)

• internal/ssh/

package ssh

func NewClient(ip, user, keyPath string) (*ssh.Client, error) { /* ... */ }
func ExecuteRemoteCommand(ip, user, keyPath, command string) error { /* ... */ }

// SSH를 사용하는 고수준 함수들
func StartZKProcess(ip, zkPath string) error { /* ... */ }
func StopZKProcess(ip, zkPath string) error { /* ... */ }
func ConfigureZKFiles(ip, port, zkPath string, myid int, zkServers []string) error { /* ... */ }
func StartMemcachedProcess(zkServers, ip, port, arcusPath, config string) error { /* ... */ }
func StopMemcachedProcess(ip, port, arcusPath string) error { /* ... */ }

• internal/zookeeper/

package zookeeper

func NewClient(addr string) (*zk.Conn, error) { /* ZK 연결 생성 로직 */ }
func InitializeZnodes(zkConn *zk.Conn) error { /* arcusBasicPaths 기반 znode 생성 로직 */ }

• internal/types/

package types

// ...
type Status struct { /* ... */ }
func (s *Status) String() string { /* ... */ }

type UserInfo struct { /* ... */ }
func (i UserInfo) String() string { /* ... */ }

// Context 키들도 여기에 함께 정의합니다.
type CtxZkConnKey struct{}
type CtxZkAclKey struct{}

현재 구현한 핵심 로직 함수를 기존 명령형 인터페이스(cmd/)의 코드에 적용하는 것까지 수행하고 PR 올릴 예정입니다.

[namsic]

필요하면 패키지 분리하면 됩니다.
통합된 형태로 구현하면 나중에 의존 관계가 얽혀 분리하기가 어려울 수 있지만,
분리된 형태로 책임을 명확히 나누어 개발해 두면 나중에 필요에 따라 합치는 것은 얼마든지 가능합니다.

대신, 내일 중으로 리뷰 마치고 반영까지 할 수 있는 상태로 진행해주세요.
이후에는 제가 코드 구조나 구현 패턴 등을 검토하고 직접 수정해두겠습니다.

[singsangssong]

인터페이스와 핵심 로직을 분리시킨 것이 머지되었습니다.
#29 에서 머지되었음으로 이슈 닫습니다.