FOSSLight Dependency Scanner

• Gradle (Java/Android)
• Maven (Java)
• NPM (Node.js)
• PyPi (Python)
• Pub (Dart with flutter)
• Cocoapods (Swift/Obj-C)
• Swift (Swift)
• Carthage (Carthage)
• Go (Go)
• Nuget (.NET)
• Helm (Kubernetes)
• Unity (Unity
• Cargo (Rust)

1. Npm dependency 분석을 수행하기 위해 NPM License Checker를 설치합니다.

   $ npm install -g license-checker
   

   license-checker를 전역 패키지로 설치하기 위해서는, 반드시 ‘-g' option을 추가해 주어야 합니다. 만약 ‘sudo' 권한이 없는 경우, 다음 명령어를 통해 전역 모듈이 설치되는 기본 path를 변경하여 이용하실 수 있습니다.

   $ npm set prefix ~/.npm
   $ PATH=~/.npm/bin:$PATH
   

2. dependency를 설치하기 위해 다음 명령어를 실행합니다. (optional)

   $ npm install
   

   아래 케이스 중 해당하는 경우, 이 단계는 skip 가능합니다.

   • package.json 파일이 input directory에 존재하는 경우 : FOSSLight Dependency Scanner에서 자동으로 패키지 설치하여 실행 가능합니다.
   • 이미 dependency들이 설치된 node_modules 디렉토리가 존재하는 경우 : node_modules폴더가 존재하는 path를 input directory로 설정하여 실행 가능합니다.

1. ‘build.gradle' 파일에 License Gradle Plugin을 추가합니다.

   plugins {
    id 'com.github.hierynomus.license' version '0.16.1' // gradle 버전이 6.x 이하인 경우에는 version '0.15.0'을 이용해야 합니다.
   }
   downloadLicenses {
    includeProjectDependencies = true
    dependencyConfiguration = 'runtimeClasspath' // gradle 버전이 4.6 이하인 경우에는 'runtimeClasspath' 대신 'runtime'으로 추가합니다.
   }
   

2. ‘downloadLicenses' task를 실행합니다.

   $ gradlew downloadLicenses
   

1. ‘build.gradle' 파일에 android-dependency-scanning Plugin을 추가합니다.

   buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'org.fosslight:android-dependency-scanning:1.0.0'
    }
   }
   

2. 플러그인이 적용되는 app 디렉토리 내에 위치한 build.gradle 파일 내에 다음과 같이 추가합니다. 이때 plugins 블록 (또는 apply plugin:'com.android.application') 하위 라인에 추가되어야 에러가 발생하지 않습니다.

   apply plugin: 'org.fosslight'
   

3. ‘generateLicenseTxt' task를 실행합니다.

   $ gradlew generateLicenseTxt
   

1. python3-venv를 설치합니다.

   $ sudo apt-get install python3-venv
   

2. 가상환경을 생성하고 활성화합니다.

   // virtualenv example
   $ virtualenv -p /usr/bin/python3.7 venv
   $ source venv/bin/activate
   // conda example
   $ conda create --name {venv name}
   $ conda activate {venv name}
   

3. 가상환경 내 분석하고자 하는 프로젝트에서 사용된 패키지를 설치합니다.
4. FOSSLight Dependency Scanner 실행 시, ‘-a', ‘-d' 옵션을 이용하여 해당 가상환경 activate, deactivate 명령어를 추가합니다.

1. pom.xml 파일에 license-maven-plugin을 추가합니다.

<project>
  ...
  <build>
  ...
    <plugins>
    ...
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>license-maven-plugin</artifactId>
        <version>2.0.0</version>
        <executions>
          <execution>
            <id>aggregate-download-licenses</id>
            <goals>
              <goal>aggregate-download-licenses</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
    ...
  </build>
  ...
</project>

2. license-maven-plugin task를 실행합니다.

$ mvnw license:aggregate-download-licenses

FOSSLight Dependency Scanner 실행하는 환경에서 flutter pub 명령어 사용 가능하지 않은 경우, flutter pub 사용 가능한 환경에서 미리 아래 과정을 수행하시기 바랍니다.

1. 다음 명령어를 통해 flutter_oss_licenses를 실행합니다. (optional)

   $ flutter pub add dev:flutter_oss_licenses:'^2.0.1'
   $ flutter pub get
   $ flutter pub deps --json > tmp_deps.json
   $ flutter pub deps --no-dev -s compact > tmp_no_dev_deps.txt
   $ flutter pub run flutter_oss_licenses:generate.dart -o tmp_flutter_oss_licenses.json --json
   

2. 1번 수행 결과에서 생성된 파일이 존재하는 path에서 FOSSLight Dependency Scanner를 실행합니다.

1. Podfile을 통해 pod package를 설치합니다.

   $ pod install
   

1. Github personal access token을 생성하여 FOSSLight Dependency Scanner 실행 시 ‘-t' 파라미터로 사용합니다. 이 토큰은 Github repository의 license정보를 가져오기 위해 Github API를 사용하기 위해 필요합니다. Token생성 방법은 Github docs 가이드를 참조하시기 바랍니다.

1. 다음과 같이 패키지 설치 명령어를 수행하여 ‘Cartfile.resolved' 파일을 생성합니다.

   $ carthage update
   

2. Github personal access token을 생성하여 FOSSLight Dependency Scanner 실행 시 ‘-t' 파라미터로 사용합니다. 이 토큰은 Github repository의 license정보를 가져오기 위해 Github API를 사용하기 위해 필요합니다. Token생성 방법은 Github docs 가이드를 참조하시기 바랍니다.