Working with Public APIs (and Reading the Documentation) for setting up Automation Tests

/**
 * Models a basic Github account which at the minimum requires
 * a {@link #userName} and {@link #userAPIKey}
 */
public class GitHub
{
    /**
    * A username for a {@link com.ultranauts.github.GitHub GitHub } account
    */
    protected String userName;

    /**
    * An apikey that is authenticated for a {@link com.ultranauts.github.GitHub GitHub } account.
    * This should be matched for the appripriate username, and configured
    * for approriate permissions when testing Github's API
    */
    protected String userAPIKey;

    /**
     * Constructor will pull user name and api key from
     * the .env file located in the project directory and assign them to
     * {@link com.ultranauts.github.GitHub GitHub } instance's {@link #userName} and {@link #userAPIKey}
     * @param dotenv to get username and api key from the .env file
     */
    public GitHub (Dotenv dotenv){
        userName = dotenv.get("PERSONAL_USER_NAME");
        userAPIKey = dotenv.get("PERSONAL_API_KEY");
    }

    /**
     * Constructor that can allow a tester to enter custom
     * username and password if .env becomes unavailable for
     * the {@link com.ultranauts.github.GitHub GitHub } Object
     * @param name to set {@link #userName}
     * @param key to set {@link #userAPIKey}
     */
    public GitHub (String name, String key){
        userName = name;
        userAPIKey = key;
    }

    /**
     * Returns the username asociated with the {@link com.ultranauts.github.GitHub GitHub } object
     * @return the {@link #userName} associated with the {@link #GitHub} Object
     */
    public String getUserName() {
        return this.userName;
    }

    /**
     * Sets a new username for the {@link com.ultranauts.github.GitHub GitHub } object
     * @param name to set {@link #userName}
     */
    public void setUserName(String name) {
        this.userName = name;
    }

    /**
     * Returns the apikey asociated with the {@link com.ultranauts.github.GitHub GitHub }
     * object (ideally paired with the proper username)
     * @return the {@link #userAPIKey} associated with the {@link com.ultranauts.github.GitHub GitHub } Object
     */
    public String getUserAPIKey() {
        return this.userAPIKey;
    }  

    /**
     * Sets a apikey string for the {@link com.ultranauts.github.GitHub GitHub } object
     * (ideaiily paired with the proper username)
     * @param key to set {@link #userAPIKey}
     */
    public void setUserAPIKey(String key) {
        this.userAPIKey = key;
    }
}

/**
 * Written class to demonstrate accessing a publically written API.
 * A personal account was used to interact with Github's API, and can
 * be reconfigured to use another personal via the .env file.  
 * @author Austin Bell
 * @version 1.0
 */
public class GitHubTest {

    /**
    * An instance of the {@link com.ultranauts.github.GitHub GitHub } class to
    * model a personal user account on GitHub. An apikey must be generated for
    * the user account in order to use the test class GitHubTest
    */
    private GitHub personalGithub;

    /**
    * The {@link io.github.cdimascio.dotenv.Dotenv Dotenv} class is used to store
    * all the information of the personal Github account. The {@link com.ultranauts.github.GitHub#GitHub(Dotenv dotenv) GitHub (Dotenv dotenv)}
    * constructor for {@link com.ultranauts.github.GitHub GitHub } will be configured
    * with the {@link io.github.cdimascio.dotenv.Dotenv Dotenv} class
    */
    private Dotenv dotenv;

    /**
    * The root URL which all the api calls make as documented in the API documentation
    */
    private String apiURL;

    /**
    * A Selenium based webdriver used to view the webpage after API calls are made when
    * performing actions that change the state of the user account
    */
    private WebDriver driver;

    /**
    * The webpage which will be used to grab a screenshot and confirm the API call was
    * successfully able to change the front end experience
    */
    private String repositoryURL;

    /**
     *
     */
    private String repositoryName;

    /**
    * A relative directory path that saves screenshots of the webpage after API calls
    * are made. This can be configured as needed
    */
    private String screenshotFolder;

    /**
    * Firefox Options set up for the driver to know which browser to use. This can
    * be changed to the appropriate browser if Firefox is not available.
    */
    private FirefoxOptions options;

    /**
     * A method intentially designed to delay 15 seconds so after an API call is made,
     * the methods executed later on can grab the appropriate state of the webpage
     * and get the correct screenshot.
     *

     * The test class navigated to webpages too quickly after the API call was made,
     * which resulted in incorrect screen grabs.
     * @throws InterruptedException
     */
    private void delay() throws InterruptedException {
        Thread.sleep(15000);
    }  

    /**
     * Generates an Header used in the API call formated "Authorization: token APIKEY", where the
     * api key of the Github account is the token value
     * @return A {@link io.restassured.http.Header Header} that authenticates the API call being made in the tests
     */
    private Header authorizedHeader(){
        String apiKey = personalGithub.getUserAPIKey();

        Header authHeader = new Header("Authorization", "token " + apiKey);

        return authHeader;
    }

    /**
     * Casts driver into an instance of {#link org.openqa.selenium.TakesScreenshot TakesScreenshot } amd
     * stores it in the designated directory for screenshots captured in the test class
     * @param driver that can capture a screenshot
     * @param fileName for the screenshot
     * @throws IOException
     */
    private void saveWebSnapShot(WebDriver driver, String fileName) throws IOException{

        TakesScreenshot scrShot =((TakesScreenshot)driver);

        File SrcFile =scrShot.getScreenshotAs(OutputType.FILE);

        File DestFile =new File(screenshotFolder + "/" + fileName);  

        FileUtils.copyFile(SrcFile, DestFile);
    }

    /**
     * Initializes all the basic member fields of the test class
     *

     * dotenv - loads the .env file
     *

     * personalGithub - loads username and api key from dotenv
     *

     * apiurl - definied in Github's API documentation "https://api.github.com"
     *

     * screenshotFolder - under root directory of project, "resources/screenshots"
     *

     * repositoryURL - [Github URL]/{User Name}?tab=repositories
     *

     * repositoryName - Can be modified as needed for testing purposes
     * @throws IOException
     */
    @BeforeTest
    public void init() throws IOException{

        dotenv = Dotenv.configure().load();
        personalGithub = new GitHub (dotenv);
        apiURL = "https://api.github.com";
        screenshotFolder = "resources/screenshots";
        repositoryURL = "https://github.com/" + personalGithub.getUserName() + "?tab=repositories";
        repositoryName = "APIGeneratedRepoPublic";
    }

    /**
     * Initializes the basic configurations. The test methods that
     * initialize the WebDriver will actually open the web browser
     * and not with this function call
    */
    @BeforeMethod
    public void initBrowser(){

        WebDriverManager.firefoxdriver().setup();

        options = new FirefoxOptions ();
        options.setPageLoadStrategy(PageLoadStrategy.EAGER);
    }

    /**
     * Test mothod to confirm that the api key is correctly accessed
     * from the .env file (mostly to verify how Dotenv worked)
     */
    @Test (priority = 0)
    public void confirmPERSONALAPIKEY(){

        String key = dotenv.get("PERSONAL_API_KEY");

        System.out.println(key);

        Assert.assertEquals(personalGithub.getUserAPIKey(), key);   
    }

    /**
     * Test mothod to confirm that the username is correctly accessed
     * from the .env file (mostly to verify how Dotenv worked)
     */
    @Test (priority = 0)
    public void confirmPERSONALUSERNAME(){

        String name = dotenv.get("PERSONAL_USER_NAME");

        System.out.println(name);

        Assert.assertEquals(personalGithub.getUserName(), name);   
    }

    /**
     * Authorized API call made to verify that the Github account's data is returned.
     *

     * A basic example of GET that should generate status code 200
    */
    @Test (priority = 0)
    public void getPersonalGithubAccount(){

        Header authHeader = authorizedHeader();

        given().
            header(authHeader).
        when().
            get(apiURL + "/user").
        then().
            statusCode(200).
            log().all(true);
    }

    /**
     * Authorized API call made to verify that a user is able to make a repository
     *

     * A basic example of POST that should generate status code 201
     * @throws IOException
     * @throws InterruptedException
     */
    @Test (priority = 1)
    public void createRepository() throws IOException, InterruptedException {
        driver = new FirefoxDriver (options);

        Header authHeader = authorizedHeader();

        Map<String,Object> bodyParameters = new HashMap <String,Object>();

        bodyParameters.put("name", "APIGeneratedRepoPublic");

        JSONObject newRepo = new JSONObject(bodyParameters);

        given().
            header(authHeader).
            body(newRepo.toJSONString()).
        when().
            post(apiURL + "/user/repos").
        then().
            statusCode(201).
            log().all(true);

        delay();

        //Maximize Window
        driver.manage().window().maximize();
        driver.manage().timeouts().implicitlyWait(20, TimeUnit.SECONDS);

        driver.get(repositoryURL);

        saveWebSnapShot(driver,"SCRN 001 - Created Repository.png");

        driver.quit();
    }

    /**
     * Authorized API call made to verify that a user's repository
     * can have the topic fields updated
     *

     * A basic example of PUT that should generate status code 200
     * @throws IOException
     * @throws InterruptedException
     */
    @Test (priority = 2)
    public void replaceRepositoryTopics() throws IOException, InterruptedException {
        driver = new FirefoxDriver (options);

        Header authHeader = authorizedHeader();

        Header mediaType = new Header("Accept", "application/vnd.github.mercy-preview+json");

        Map<String,Object> bodyParameters = new HashMap <String,Object>();

        bodyParameters.put("names", Arrays.asList("sample","api","java","automation"));

        JSONObject newRepo = new JSONObject(bodyParameters);

        given().
            header(authHeader).
            header(mediaType).
            body(newRepo.toJSONString()).
        when().
            put(apiURL + "/repos/" + personalGithub.getUserName() + "/" + repositoryName + "/topics").
        then().
            statusCode(200).
            log().all(true);

        delay();

        //Maximize Window
        driver.manage().window().maximize();
        driver.manage().timeouts().implicitlyWait(20, TimeUnit.SECONDS);

        driver.get(repositoryURL);

        saveWebSnapShot(driver,"SCRN 002 - Repository topics updated.png");

        driver.quit();
    }

    /**
     * Authorized API call made to verify that a user's repository
     * can have the description modified
     *

     * A basic example of PATCH that should generate status code 200
     * @throws IOException
     * @throws InterruptedException
     */
    @Test (priority = 3)
    public void updateRepository() throws IOException, InterruptedException {
        driver = new FirefoxDriver (options);

        Header authHeader = authorizedHeader();

        Map<String,Object> bodyParameters = new HashMap <String,Object>();

        bodyParameters.put("description", "Patched description on my newly created repository");
        //bodyParameters.put("private", "true");

        JSONObject newRepo = new JSONObject(bodyParameters);

        given().
            header(authHeader).
            body(newRepo.toJSONString()).
        when().
            patch(apiURL + "/repos/" + personalGithub.getUserName() + "/" + repositoryName).
        then().
            statusCode(200).
            log().all(true);

        delay();

        //Maximize Window
        driver.manage().window().maximize();
        driver.manage().timeouts().implicitlyWait(20, TimeUnit.SECONDS);

        driver.get(repositoryURL);

        saveWebSnapShot(driver,"SCRN 003 - Repository set to private and updated description.png");

        driver.quit();
    }

    /**
     * Authorized API call made to verify that a user's repository
     * can be deleted
     *

     * A basic example of DELETE that should generate status code 204
     * @throws IOException
     * @throws InterruptedException
     */
    @Test (priority = 4)
    public void deleteRepository() throws IOException, InterruptedException {
        driver = new FirefoxDriver (options);

        Header authHeader = authorizedHeader();

        given().
            header(authHeader).
        when().
            delete(apiURL + "/repos/" + personalGithub.getUserName() + "/" + repositoryName).
        then().
            statusCode(204).
            log().all(true);

        delay();

        //Maximize Window
        driver.manage().window().maximize();
        driver.manage().timeouts().implicitlyWait(20, TimeUnit.SECONDS);

        driver.get(repositoryURL);

        saveWebSnapShot(driver,"SCRN 004 - Repository Deleted.png");

        driver.quit();
    }
}