Diary #1, Dagger의 Child Fragment 관련

주의사항!

이 포스트는 주인장(@WindSekirun) 과 여러 사람들과 개발(특히 Android 관련이 많습니다)에 관련된 이야기를 할 때, 간단히 다루기 좋은 이야기를 있는 그대로 표현하는 포스트입니다. 대화 내용은 보기 좋게만 변경하고, 오탈자는 수정하지 않습니다. 만일 대화중 틀린 내용이나 보강할 내용이 있다면 댓글로 알려주시면 감사합니다!

아니면 텔레그램 WindSekirun 으로 주셔도 됩니다.

이번 주제

Dagger에서 ChildFragment를 ParentFragment가 관리해야 되는 것인가, 아니면 Activity가 관리해야 되는 것인가?

등장인물

  • Pyxis, 주인장
  • @Zeallat , 언제나 도움을 주셔서 매우 감사한 분입니다.

정답

등잔 밑이 어둡다고, Dagger 공식 레포 상에 답이 있습니다. 링크는 [여기] 로, DialogFragment의 베이스 클래스의 구현체입니다. 보면 onAttach에서 AndroidSupportInjection 을 통해 injection 하는 것을 확인할 수 있습니다.

즉 ChildFragment는 Parent Fragment가 관리하는 게 맞고, injection 은 위를 참고하면 됩니다

대회내용

  • Pyxis: 무튼
  • Pyxis: Dagger 에 스코프가 있을 때
  • Pyxis: Activity : Service: BroadcastReceiver: ContentProvider는
  • Pyxis: Application 스코프잖아요
  • Pyxis: 그래서 DispatchingAndroidInjector 를 Application에서
  • Pyxis: 구현하고
  • Pyxis: 그리고 Fragment는
  • Pyxis: 공식 컴포넌트가 아니고: Activity에 종속적이기 때문
  • Pyxis: 에
  • Pyxis: Activity에 종속적이고
  • Pyxis: 그리고 DialogFragment가 있어요
  • Pyxis: Fragment도 Activity 종속이고: 다이얼로그도 Activity종속이라 볼 수 있어요 (Window Token 관련 살펴보면 이렇게 결론 내릴 수 있음)
  • Pyxis: 여기서: DialogFragment 안에 ChildFragment가 있다고 할때
  • Pyxis: 이 Fragment는 Activity에 관리하는게 맞을까요
  • Pyxis: 아니면 parnet fragment (여기서는 DialogFragment)가 관리해야될까요
  • Zeallat: 스코프를요?
  • Pyxis: DispatchingAndroidInjector를 받아서
  • Zeallat: activity life cycle에 맞추느냐
  • Pyxis: HasSupportFragmentInjector 같은거
  • Pyxis: 구현하고
  • Zeallat: fragment lifecycle에 맞추느냐
  • Zeallat: 그건가여?
  • Pyxis: 라이프사이클 관련
  • Pyxis: 네 어떻게 보면 라이프사이클이네여
  • Pyxis: 저는 진짜 왠만하면
  • Pyxis: child fragment는 안만들려고 하거든요
  • Pyxis: 예전에 당한게 하도 많아서
  • Zeallat: 어떤 케이스이죠?
  • Pyxis: 그래서 저 경우를 아예 생각하고 있지 않았는데
  • Pyxis: DialogFragment 하나로
  • Pyxis: 여러개의 Fragment를 replace?
  • Pyxis: 하는 그런목적인거같아요
  • Pyxis: 지금 구성하는 앱이
  • Pyxis: 연속적으로 다이얼로그만 4~6개 뜨게 되있어서
  • Pyxis: 하나하나 dismiss해서 하는거보다 내부에서 관리하는게
  • Pyxis: 더 효율성있다고는 보거든요
  • Zeallat: 음
  • Zeallat: 그러니까
  • Zeallat: 페이지 하나에서 fragment(팝업)을 여러개 표시해야하는데
  • Zeallat: 그걸 replace로 하기위해서
  • Zeallat: dialog 하나 만들고 그안에서
  • Zeallat: child 여러개를 컨트롤한다는 이야기인가요?
  • Pyxis: Exactly
  • Zeallat: 그런데
  • Zeallat: 이 parent fragment가
  • Zeallat: 여러 activity에서 불리는 시츄에이션인가요?
  • Pyxis: 아뇨
  • Pyxis: 기획적으로는 하나의 activity
  • Pyxis: 에서만 불리는데
  • Zeallat: 그럼 왜 굳이 parent를 만들어요?
  • Pyxis: 한 화면내에서 여러번 불릴 가능성은
  • Pyxis: 있어요
  • Zeallat: 그냥 activity에서 replace 컨트롤 하면 안되나요?
  • Pyxis: activity는
  • Zeallat: 아니면 공통 view를 공유하나요?parent의?
  • Pyxis: 그대로 두고
  • Pyxis: parent의 공통 뷰를
  • Pyxis: 공유하죠
  • Pyxis: parent dialog에는 타이틀이랑 x버튼
  • Pyxis: 같은거 두고
  • Pyxis: 그 안 fragment에서는
  • Pyxis: N:1 관계로
  • Pyxis: (1이 ViewModel)
  • Pyxis: 상태 관리하고
  • Pyxis: 대충 어떤 시나리오인지
  • Pyxis: 예상가시나여?
  • Zeallat: 네 이해가요
  • Zeallat: parent fragment에서 단순 호출이아니고
  • Zeallat: parent의 일부 뷰에만
  • Zeallat: child를 표시한다는거죠?
  • Pyxis: 네
  • Pyxis: AndroidSupportInjection.inject 코드 보니까
  • Pyxis: parent fragment를 찾는거같은 코드가
  • Pyxis: 있더라고요
  • Pyxis: 그렇게 되면 제 생각은
  • Pyxis: ParentFragment 가 ChildFragment를 관리하는게
  • Pyxis: 관점에선 맞아보이는데
  • Zeallat: 일단 뭐 그런 케이스라면
  • Zeallat: parent fragment 죽으면
  • Zeallat: child도 다 죽어야죠
  • Pyxis: 그렇겠져
  • Zeallat: scope측면에서
  • Zeallat: parent에 종속적이여야하죠
  • Pyxis: 그렇죠
  • Pyxis: 그게 좀 더 하긴 하는데
  • Pyxis: AndroidSupportInjection 쓰니까
  • Pyxis: Non injected 로그 뜨면서
  • Pyxis: 인젝트가 안되더라고요
  • Pyxis: parent fragmentㅇ서
  • Pyxis: 에서
  • Pyxis: 여기서 parent fragment인 DialogFragment에 injection이 왜 필요한가
  • Pyxis: 하면
  • Pyxis: scope 의 생성은 HasSupportFragmnetInjector 인터페이스 기반이라
  • Pyxis: 서브컴포넌트도 이 기준으로 생성되고
  • Pyxis: 그래서 parent fragment가 child fragment를 가지기 위해서는
  • Pyxis: parent fragment가 HasSupportFragmentInjector를 구현하고
  • Pyxis: DIspatchingAndroidInjector를 반환해야 되는데
  • Pyxis: 구현하는거까진 문제가 없는데
  • Pyxis: DialogFragment의 onCreateView에서 AndroidSupportInjection 하니까
  • Pyxis: 죽더라고요
  • Pyxis: 그래서 일단 임시방편으로 AppComponent에다가
  • Pyxis: inject 메서드 만들어놓고
  • Pyxis: 그걸 호출하는 식으로 강제 인젝트는 했는데
  • Pyxis: 결론적으로
  • Pyxis: 이 접근방법이 맞는건지: 그리고 이 경우에 dialogfragment에 정상적으로 inject하는 방법이 어떤건지
  • Pyxis: 이 두개가 문제였어요
  • Pyxis: 일단 dagger-android 자체는 DialogFragment를 정식적으로 지원하고는 있어요
  • Pyxis: https://github.com/google/dagger/blob/master/java/dagger/android/DaggerDialogFragment.java
  • Pyxis: ?
  • Pyxis: 잠만
  • Pyxis: 이 링크가 답이네요
  • Pyxis: ㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋ
  • Zeallat: 휴 오늘도 제가 Pyxis님 고민을 한건 해결해드렸군요
  • Zeallat: Pyxis님 저 없으면 어떻게 사시나요
  • Pyxis: ㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋ
  • Zeallat: 하하
  • Pyxis: 혼자 막 정리해보니
  • Pyxis: 답이 나옴
  • Zeallat: 그래서 답이뭔가요?
  • Zeallat: 그냥 저 링크식으로
  • Pyxis: 네
  • Zeallat: android injection
  • Zeallat: 하면되나여
  • Pyxis: onAttach에서
  • Pyxis: 해주면 되는거같아요]
  • Zeallat: onCreateView가 아니고
  • Zeallat: onAttatch가 해담인가요
  • Zeallat: ㅋㅋ
  • Pyxis: 뭐 그러면 복잡하게 할 필요 없이
  • Pyxis: DialogFragment에다가 InjectFragmnet달아놓고
  • Pyxis: onAttach에다가 걸면 되겠네여
  • Pyxis: 담 버전부터 대응해봐야될듯

Kotlin Coverage Test – Static Analysis with Jenkins

Kotlin으로 모듈을 작성하다 보면, 모듈의 각 코드에 대한 단위 테스트와 코드 분석을 진행할 필요가 있다.

특히 그 모듈은 구(공 모양의 도형) 상에 존재하는 x개의 데이터 셋에 대해 y 를 제공했을 때, 데이터 셋 상에서 y에 최근접해있는 데이터를 찾는 모듈이었기 때문이었다.

그래서 모듈을 구성하는 모든 코드에 대한 단위 테스트를 진행하여 최대한 모듈 상의 버그를 없애고 (물론, 로직을 구성하는 최하위 알고리즘 상에 문제는 생길 수는 있다. 다만, 서울에서 멀리 떨어진 지역의 데이터이기 때문에 검증하기도 많이 어렵다.) 퍼포먼스, 보안 상 문제가 될 수 있는 모든 가능성을 없앨 필요가 있었다.

이 글에서는 그 과정에서 도입한 Spek Framework, Jacoco Report, Detekt 에 대해 알아보고, 이 세 개를 Jenkins에 연동하여 Jenkins dashboard 에서 해당 리포트에 대해 보여주는 과정을 살펴보려 한다.

Spek Framework

Spek Framework란 코틀린용 유닛 테스트 프레임워크로 Kotlin의 기여자들이 관리하는 프레임워크이다. (JetBrains 공식 프로젝트는 아니나, JetBrains 가 개발한 흔적은 있다.) 현재는 2.0.0-RC1 버전으로, 특징적인 점이라면 DSL로 유닛 테스트를 진행할 수 있다는 점이다.

class SomeTest: Spek({
    describe("Some test") {
        it("Check value is something") {
            // TEST BODY
        }
    }
})

이러한 구조를 가지고 있어 JUnit와 다른 테스트 프레임워크와는 다르게 쉬운 구조를 가지고 있다.

(이렇게 보면, Ktor도 그렇고 JetBrains 가 개발한 프레임워크들은 DSL를 매우 강조하는 것 같다. 과연 그것이 좋은지는 아직도 잘 모르겠긴 하다.)

임포트는 다음과 같이 진행한다.

buildscript {
    ext.kotlin_version = '1.3.11'
    ext.spek_version = '2.0.0-rc.1'
    ext.junit_version = '4.12'
​
    repositories {
        jcenter()
    }
​
    dependencies {
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
    }
}
​
dependencies {
    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
    testImplementation "org.jetbrains.kotlin:kotlin-test:$kotlin_version"
    testImplementation "org.spekframework.spek2:spek-dsl-jvm:$spek_version"
    testRuntimeOnly "org.spekframework.spek2:spek-runner-junit5:$spek_version"
    testRuntimeOnly "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version"
    testCompile("org.assertj:assertj-core:3.11.1")
    testCompile "junit:junit:$junit_version"
}
​
test {
    useJUnitPlatform {
        includeEngines 'spek2'
    }
}

이렇게 작성한 테스트 코드는 gradlew test 로 확인이 가능하다.

Jacoco Report

Jacoco Report는 Java Code Coverage를 구현하는 데 사용하는 툴킷으로, Line, Branch에 대한 Coverage를 제공한다.

임포트는 다음과 같이 한다.

apply plugin: 'jacoco'
​
test {
    useJUnitPlatform {
        includeEngines 'spek2'
    }
    jacoco {
        destinationFile = file("${buildDir}/jacoco/test.exec")
    }
}
​
test.finalizedBy(jacocoTestReport)
​
jacoco {
    // You may modify the Jacoco version here
    toolVersion = "0.8.2"
}
​
jacocoTestReport {
    // Adjust the output of the test report
    reports {
        xml.enabled true
        csv.enabled false
    }
}

gradlew test 로 테스트를 구동했을 경우, destinationFile로 제공한 경로에 exec 파일이 저장된다. 이 exec 파일은 Jacoco 가 생성한 리포트 파일이 포함되며, gradlew jacocoTestReport 명령어로 리포트 파일을 생성할 수 있다. (여기서는 xml, html 리포트를 생성한다.)

Detekt

Detekt는 코틀린에 대한 Static Analysis를 제공하는 툴킷으로, 코틀린으로 코드를 작성함에 있어 피해야하는 패턴들에 대해 감지, 특정 패턴들의 가중치를 파악해서 일정 이상이면 build 자체가 failed 되게 할 수 있어 코드 본연의 문제를 좀 더 파악할 수 있게 하는 툴킷이다.

특히 Codacy (https://www.codacy.com/) 에서 코틀린 프로젝트를 임포트 했을 때 사용하는 분석 툴킷으로, 많은 사람들에 의해 검증된 툴킷이기도 하다.

임포트 과정은 프로젝트 사이트(https://arturbosch.github.io/detekt/) 에 설명되어 있다.

detekt의 경우 gradlew detekt 로 통해 테스트를 진행할 수 있다. 이 때 report는 build/reports/detekt 에 detekt.html 에 저장되며 이 리포트 파일을 참고로 해서 파악할 수 있다.

Jenkins로 실행

위에서 살펴본 Spek Framework, Jacoco, Detekt를 빌드마다 실행하기 위해서 JenkinsFile에 해당 과정을 구현했다.

stage('Test Analysis') {
      parallel {
        stage('Static Analysis') {
          steps {
            sh './gradlew detekt'
            publishHTML(target: [reportDir:'build/reports/detekt/', reportFiles: 'detekt.html', reportName: 'Detekt report'])
          }
        }
        stage('Unit Test') {
          steps {
            sh './gradlew cleanTest test'
            sh './gradlew jacocoTestReport'
            publishHTML(target: [reportDir:'build/reports/jacoco/test/html', reportFiles: 'index.html', reportName: 'Code Coverage'])
          }
        }
      }
    }

gradlew build 가 끝난 다음, 이 단계를 실행하게 하면 된다. publishHTML은 특정 Html 파일을 Jenkins 메뉴 상에 표시해서 쉽게 볼 수 있게 한다.

Jenkins에 테스트 결과에 대한 Output 출력

Test Code를 작성할 때 println 메서드로 Test 콘솔에 Output를 출력할 수 있으나, 위 JenkinsFile를 가지고 실행하면 Output가 나오지 않는다.

이 때는 https://stackoverflow.com/a/36130467 링크에 있는 답변을 사용하면 된다.

최종 결과

전체 파이프라인 통과
각 테스트에 대해 PASSED / FAILED / SKIPPED 등이 표시된다. 만일 Output가 있을 경우 그 아래에 표시된다.
마지막에 총 결과가 표시된다.
Detekt 분석 결과는 콘솔에도 표시된다. 물론, 리포트에도 볼 수 있다.
Jenkins 의 메뉴에 Code Coverage, Detekt Report가 생긴 것을 확인할 수 있다.
Detekt가 생성한 report 파일이다.
Jacoco가 생성한 Coverage Report로, Line Coverage는 99%, Branch Coverage는 94%로 측정되었다.

마무리

제목은 다소 거창하지만, 실제로 한 행동은 그렇게 어렵지는 않다. 다만 이 글에서 사용한 프로젝트는 순수 Kotlin 프로젝트로 안드로이드 프로젝트는 아니다.

이 면에서 보면, 안드로이드 프로젝트에 대해 유닛 테스트를 진행하는 것은 다소 어렵기 때문에 조금 진입장벽이 높을 수는 있다고는 판단된다.

하지만 작은 것 부터 나아가면, 점점 더 나아질 것이라 생각한다.

NaraeAudioRecorder, AudioRecorder for Android

회사에서 프로젝트를 진행하던 도중, 음성 녹음에 대한 기능을 개발할 일이 있었다.

예전(아마 2017년쯤)에 쓰던 lameMp3 wrapper가 있었기에 그대로 활용했었는데, 최신 환경에서는 녹음된 소리가 제대로 나오지 않고 이상하게 나오는 현상이 있었다.

그래서, 이번 주말동안 기존에 AudioRecord를 만졌던 기억을 되살려 음성 녹음 라이브러리를 만들게 되었고, 그것이 바로 WindSekirun/NaraeAudioRecorder 이다.

구조

크게 바라보면 해당 라이브러리는 총 4개의 파트로 구성된다.

  • AudioChunk: AudioRecord에서 bufferSize 만큼 읽어온 만큼의 raw 데이터와 raw 데이터에 대한 정보를 담고 있다.
  • AudioRecorder: Wav, PCM, FFmpeg 등 여러 포맷에 대한 객체로 start, stop, resume, pause 이벤트에 맞춰 작업을 실행한다.
  • AudioSource: 기본과 NoiseSuppressor (배경 노이즈를 제거하는 안드로이드 API 전처리기) 에 대한 기본 속성이며, AudioRecord에 대한 정보를 갖고 있다.
  • RecordWriter: AudioSource 와 AudioRecorder 사이에 있는 중간 매개체로 AudioSource로 설정한 AudioRecord에서 bufferSize만큼 raw data를 가져와 OutputStream에 쓰고, 그 이벤트를 AudioRecorder 에 전달하는 역할을 한다.

각각 유기적으로 연결되어있어, 처리 순서는 AudioRecorder > RecordWriter > AudioChunk 이고, AudioSource는 RecordWriter를 사용하기 위한 AudioRecord 설정 객체라 이해하면 편하다.

특이점

특이점이라 한다면 AudioRecord에서 가져오는 데이터는 raw 데이터이고, 이를 wav나 mp3 등으로 변환하기 위해서는 특별한 작업이 필요하다.

예전에도 AudioRecord to Wav 란 주제로 다룬 적이 있었고, 이번에도 특별한 작업은 없다.

mp3, aac, wma 로 변환하기 위해서 FFmpeg를 사용했는데, FFmpeg에 대한 command를 구성하도록 했다

val tempFile = File(file.parent, "tmp-${file.name}")
commandBuilder.addAll(listOf("-y", "-i", file.path))

if (convertConfig.samplingRate != FFmpegSamplingRate.ORIGINAL) {
     commandBuilder.addAll(listOf("-ar", convertConfig.samplingRate.samplingRate.toString()))
}

if (convertConfig.bitRate !== FFmpegBitRate.def) {
    commandBuilder.addAll(listOf("-sample_fmt", convertConfig.bitRate.bitRate))
}

if (convertConfig.mono) {
    commandBuilder.addAll(listOf("-ac", "1"))
}

commandBuilder.add(tempFile.path)

FFmpeg를 다뤄보는 것은 두번째이기 때문에, 다소 그렇게 삽질하지는 않은 것 같다. (아마도… (._.

물론 FFmpeg를 사용한다면 라이센스 문제가 나오기 때문에, 멀티 모듈로 구성해서 core만을 사용한다면 FFmpeg에 의존성이 없게 구성했다. 아무래도 FFmpeg를 프로덕션에서 바로 사용하기에는 부적절한 면도 있기도 하다.

마지막으로 조금 특이한 점이라면, 목적 파일의 확장자에 따라 wav, mp3 등 각각의 recorder로 넘기는데 이 과정에서 리플렉션을 통해 접근했다는 점이다.

class FFmpegRecordFinder : RecordFinder {

    /**
     * see [RecordFinder.find]
     */
    override fun find(extension: String, file: File, writer: RecordWriter): AudioRecorder {
        return when (extension) {
            "wav" -> WavAudioRecorder(file, writer)
            "pcm" -> PcmAudioRecorder(file, writer)
            "aac" -> FFmpegAudioRecorder(file, writer)
            "mp3" -> FFmpegAudioRecorder(file, writer)
            "m4a" -> FFmpegAudioRecorder(file, writer)
            "wma" -> FFmpegAudioRecorder(file, writer)
            "flac" -> FFmpegAudioRecorder(file, writer)
            else -> PcmAudioRecorder(file, writer)
        }
    }

}

RecordFinder 란 클래스에서 find 메서드를 통해 Recorder 로 넘기고, 이 RecordFinder를 Class 객체를 사용하여 바로 인스턴스를 만들고 활용하는 방법으로 접근했다.

 try {
            val finder = recordFinder.getConstructor().newInstance() as? RecordFinder
                    ?: throw IllegalArgumentException(LogConstants.EXCEPTION_FINDER_NOT_HAVE_EMPTY_CONSTRUCTOR)

            val file = recorderConfig.destFile ?: return // it can't be null
            audioRecorder = finder.find(file.extension, file, recordWriter)
} catch (exception: Exception) {
            throw IllegalArgumentException(LogConstants.EXCEPTION_FINDER_NOT_HAVE_EMPTY_CONSTRUCTOR, exception)
}

물론 해당 RecordFinder 클래스를 정확한 형식에 맞추지 않고 개발을 진행했을 경우 사용하지 못한다는 문제점이 있지만, 가능한 멀티모듈로 구성하면서도 유기적으로 연계되기 위해서 해당 방법을 사용했다. (적어도 개발자 자신이 확정할 수 있으면 괜찮지 않을까.. 라는 조금 어린 생각을 가지기도 했다.)

마무리

총 3일동안 개발하면서 나름대로 코드를 최대한 깔끔하게 짜고, 문서화도 제대로 하려고는 노력은 했지만 아직까지 표현력이 부족한 점도 많긴 많았다.

그래도 2019년 한 해의 시작을 라이브러리로 시작했으니, 이번 년도 말에도 라이브러리 개발로 끝날 것 같기도 하다.

마지막으로 개발했던 모든 소스와 샘플들은
WindSekirun/NaraeAudioRecorder 에 공개되어 있다. JCenter에도 배포되어있으니, 바로 다운 받아 사용이 가능하다.