FunctionsCoreApiTest.java

/*
 * RevEng.AI API
 * RevEng.AI is Similarity Search Engine for executable binaries
 *
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


package ai.reveng.api;

import ai.reveng.invoker.ApiException;
import ai.reveng.model.AiUnstripRequest;
import ai.reveng.model.AnalysisFunctionMatchingRequest;
import ai.reveng.model.AutoUnstripRequest;
import ai.reveng.model.AutoUnstripResponse;
import ai.reveng.model.BaseResponse;
import ai.reveng.model.BaseResponseAnalysisStringsResponse;
import ai.reveng.model.BaseResponseAnalysisStringsStatusResponse;
import ai.reveng.model.BaseResponseCalleesCallerFunctionsResponse;
import ai.reveng.model.BaseResponseFunctionBlocksResponse;
import ai.reveng.model.BaseResponseFunctionCapabilityResponse;
import ai.reveng.model.BaseResponseFunctionStringsResponse;
import ai.reveng.model.BaseResponseFunctionsDetailResponse;
import ai.reveng.model.FunctionMatchingRequest;
import ai.reveng.model.FunctionMatchingResponse;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * API tests for FunctionsCoreApi
 */
@Disabled
public class FunctionsCoreApiTest {

    private final FunctionsCoreApi api = new FunctionsCoreApi();

    /**
     * Performs matching and auto-unstrip for an analysis and its functions
     *
     * Takes in the analysis ID, uses the functions ID's from it and settings to find the nearest function groups for each function that's within the system
     *
     * @throws ApiException if the Api call fails
     */
    @Test
    public void aiUnstripTest() throws ApiException {
        Integer analysisId = null;
        AiUnstripRequest aiUnstripRequest = null;
        AutoUnstripResponse response = api.aiUnstrip(analysisId, aiUnstripRequest);
        // TODO: test validations
    }

    /**
     * Perform matching for the functions of an analysis
     *
     * Takes in an analysis id and settings and matches the nearest functions to the ones associated with it. Results can optionally be filtered by collection, binary, debug type or (other) function ids
     *
     * @throws ApiException if the Api call fails
     */
    @Test
    public void analysisFunctionMatchingTest() throws ApiException {
        Integer analysisId = null;
        AnalysisFunctionMatchingRequest analysisFunctionMatchingRequest = null;
        FunctionMatchingResponse response = api.analysisFunctionMatching(analysisId, analysisFunctionMatchingRequest);
        // TODO: test validations
    }

    /**
     * Performs matching and auto-unstrip for an analysis and its functions
     *
     * Takes in the analysis ID, uses the functions ID's from it and settings to find the nearest function for each function that's within the system
     *
     * @throws ApiException if the Api call fails
     */
    @Test
    public void autoUnstripTest() throws ApiException {
        Integer analysisId = null;
        AutoUnstripRequest autoUnstripRequest = null;
        AutoUnstripResponse response = api.autoUnstrip(analysisId, autoUnstripRequest);
        // TODO: test validations
    }

    /**
     * Perform function matching for an arbitrary batch of functions, binaries or collections
     *
     * Takes in an input of functions ID's and settings and finds the nearest functions for each function that's within the system
     *
     * @throws ApiException if the Api call fails
     */
    @Test
    public void batchFunctionMatchingTest() throws ApiException {
        FunctionMatchingRequest functionMatchingRequest = null;
        FunctionMatchingResponse response = api.batchFunctionMatching(functionMatchingRequest);
        // TODO: test validations
    }

    /**
     * Cancels a running ai-unstrip
     *
     * Takes in the analysis ID and cancels a running ai-unstrip operation
     *
     * @throws ApiException if the Api call fails
     */
    @Test
    public void cancelAiUnstripTest() throws ApiException {
        Integer analysisId = null;
        AutoUnstripResponse response = api.cancelAiUnstrip(analysisId);
        // TODO: test validations
    }

    /**
     * Cancels a running auto-unstrip
     *
     * Takes in the analysis ID and cancels a running auto-unstrip operation
     *
     * @throws ApiException if the Api call fails
     */
    @Test
    public void cancelAutoUnstripTest() throws ApiException {
        Integer analysisId = null;
        AutoUnstripResponse response = api.cancelAutoUnstrip(analysisId);
        // TODO: test validations
    }

    /**
     * Get string information found in the Analysis
     *
     * Get string information found in the analysis
     *
     * @throws ApiException if the Api call fails
     */
    @Test
    public void getAnalysisStringsTest() throws ApiException {
        Integer analysisId = null;
        Integer page = null;
        Integer pageSize = null;
        String search = null;
        String functionSearch = null;
        String orderBy = null;
        String sortOrder = null;
        BaseResponseAnalysisStringsResponse response = api.getAnalysisStrings(analysisId, page, pageSize, search, functionSearch, orderBy, sortOrder);
        // TODO: test validations
    }

    /**
     * Get string processing state for the Analysis
     *
     * Get string processing state for the Analysis
     *
     * @throws ApiException if the Api call fails
     */
    @Test
    public void getAnalysisStringsStatusTest() throws ApiException {
        Integer analysisId = null;
        BaseResponseAnalysisStringsStatusResponse response = api.getAnalysisStringsStatus(analysisId);
        // TODO: test validations
    }

    /**
     * Get disassembly blocks related to the function
     *
     * Get disassembly blocks related to the function
     *
     * @throws ApiException if the Api call fails
     */
    @Test
    public void getFunctionBlocksTest() throws ApiException {
        Integer functionId = null;
        BaseResponseFunctionBlocksResponse response = api.getFunctionBlocks(functionId);
        // TODO: test validations
    }

    /**
     * Get list of functions that call or are called by the specified function
     *
     * @throws ApiException if the Api call fails
     */
    @Test
    public void getFunctionCalleesCallersTest() throws ApiException {
        Integer functionId = null;
        BaseResponseCalleesCallerFunctionsResponse response = api.getFunctionCalleesCallers(functionId);
        // TODO: test validations
    }

    /**
     * Retrieve a functions capabilities
     *
     * @throws ApiException if the Api call fails
     */
    @Test
    public void getFunctionCapabilitiesTest() throws ApiException {
        Integer functionId = null;
        BaseResponseFunctionCapabilityResponse response = api.getFunctionCapabilities(functionId);
        // TODO: test validations
    }

    /**
     * Get function details
     *
     * @throws ApiException if the Api call fails
     */
    @Test
    public void getFunctionDetailsTest() throws ApiException {
        Integer functionId = null;
        BaseResponseFunctionsDetailResponse response = api.getFunctionDetails(functionId);
        // TODO: test validations
    }

    /**
     * Get string information found in the function
     *
     * Get string information found in the function
     *
     * @throws ApiException if the Api call fails
     */
    @Test
    public void getFunctionStringsTest() throws ApiException {
        Integer functionId = null;
        Integer page = null;
        Integer pageSize = null;
        String search = null;
        BaseResponseFunctionStringsResponse response = api.getFunctionStrings(functionId, page, pageSize, search);
        // TODO: test validations
    }

}